ホーム › System.ApplicationInstallationAndServicing › MsiEnumPatchesA

MsiEnumPatchesA

関数

製品に適用されたパッチを列挙する(ANSI版)。

DLLmsi.dll文字セットANSI (-A)呼出規約winapi対応OSwindows8.0

シグネチャ

// msi.dll  (ANSI / -A)
#include <windows.h>

DWORD MsiEnumPatchesA(
    LPCSTR szProduct,
    DWORD iPatchIndex,
    LPSTR lpPatchBuf,
    LPSTR lpTransformsBuf,
    DWORD* pcchTransformsBuf
);

パラメーター

名前	型	方向	説明
szProduct	LPCSTR	in	パッチを列挙する対象の製品の製品コードを指定します。
iPatchIndex	DWORD	in	取得するパッチのインデックスを指定します。このパラメーターは、 MsiEnumPatches 関数の最初の呼び出しではゼロにし、以降の呼び出しでは値を増加させます。
lpPatchBuf	LPSTR	out	パッチの GUID を受け取るバッファーへのポインターです。この引数は必須です。
lpTransformsBuf	LPSTR	out	パッチ内の、製品に適用可能なトランスフォームの一覧を受け取るバッファーへのポインターです。この引数は必須であり、Null にすることはできません。
pcchTransformsBuf	DWORD*	inout	関数が失敗して返った場合に、lpTransformsBuf にコピーされた文字数が設定されます。正常に返った場合は設定されません。入力時には、終端の null 文字分の領域を含むバッファー全体のサイズを指定します。渡されたバッファーが小さすぎる場合、返される文字数には終端の null 文字は含まれません。

戻り値の型: DWORD

公式ドキュメント

MsiEnumPatches 関数は、製品に適用されたすべてのパッチを列挙します。(ANSI)

戻り値

Value	Meaning
ERROR_BAD_CONFIGURATION	構成データが破損しています。
ERROR_INVALID_PARAMETER	無効なパラメーターが関数に渡されました。
ERROR_NO_MORE_ITEMS	返すパッチがありません。
ERROR_SUCCESS	値が列挙されました。
ERROR_MORE_DATA	バッファーが小さすぎて、要求されたデータを格納できません。

解説(Remarks)

パッチを列挙するには、アプリケーションはまず iPatchIndex パラメーターをゼロに設定して MsiEnumPatches 関数を呼び出します。その後、iPatchIndex パラメーターの値を増加させながら、製品がなくなるまで(関数が ERROR_NO_MORE_ITEMS を返すまで) MsiEnumPatches を呼び出します。

バッファーが小さすぎて要求されたデータを格納できない場合、 MsiEnumPatches は ERROR_MORE_DATA を返し、pcchTransformsBuf には Null 文字を除いた、lpTransformsBuf にコピーされた文字数が格納されます。

メモ

msi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版と Unicode 版を自動的に選択するエイリアスとして MsiEnumPatches を定義します。エンコーディング非依存のエイリアスの使用と、エンコーディング非依存ではないコードを混在させると、不一致が生じてコンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// msi.dll  (ANSI / -A)
#include <windows.h>

DWORD MsiEnumPatchesA(
    LPCSTR szProduct,
    DWORD iPatchIndex,
    LPSTR lpPatchBuf,
    LPSTR lpTransformsBuf,
    DWORD* pcchTransformsBuf
);

[DllImport("msi.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint MsiEnumPatchesA(
    [MarshalAs(UnmanagedType.LPStr)] string szProduct,   // LPCSTR
    uint iPatchIndex,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpPatchBuf,   // LPSTR out
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpTransformsBuf,   // LPSTR out
    ref uint pcchTransformsBuf   // DWORD* in/out
);

<DllImport("msi.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function MsiEnumPatchesA(
    <MarshalAs(UnmanagedType.LPStr)> szProduct As String,   ' LPCSTR
    iPatchIndex As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> lpPatchBuf As System.Text.StringBuilder,   ' LPSTR out
    <MarshalAs(UnmanagedType.LPStr)> lpTransformsBuf As System.Text.StringBuilder,   ' LPSTR out
    ByRef pcchTransformsBuf As UInteger   ' DWORD* in/out
) As UInteger
End Function

' szProduct : LPCSTR
' iPatchIndex : DWORD
' lpPatchBuf : LPSTR out
' lpTransformsBuf : LPSTR out
' pcchTransformsBuf : DWORD* in/out
Declare PtrSafe Function MsiEnumPatchesA Lib "msi" ( _
    ByVal szProduct As String, _
    ByVal iPatchIndex As Long, _
    ByVal lpPatchBuf As String, _
    ByVal lpTransformsBuf As String, _
    ByRef pcchTransformsBuf As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

MsiEnumPatchesA = ctypes.windll.msi.MsiEnumPatchesA
MsiEnumPatchesA.restype = wintypes.DWORD
MsiEnumPatchesA.argtypes = [
    wintypes.LPCSTR,  # szProduct : LPCSTR
    wintypes.DWORD,  # iPatchIndex : DWORD
    wintypes.LPSTR,  # lpPatchBuf : LPSTR out
    wintypes.LPSTR,  # lpTransformsBuf : LPSTR out
    ctypes.POINTER(wintypes.DWORD),  # pcchTransformsBuf : DWORD* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiEnumPatchesA = Fiddle::Function.new(
  lib['MsiEnumPatchesA'],
  [
    Fiddle::TYPE_VOIDP,  # szProduct : LPCSTR
    -Fiddle::TYPE_INT,  # iPatchIndex : DWORD
    Fiddle::TYPE_VOIDP,  # lpPatchBuf : LPSTR out
    Fiddle::TYPE_VOIDP,  # lpTransformsBuf : LPSTR out
    Fiddle::TYPE_VOIDP,  # pcchTransformsBuf : DWORD* in/out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "msi")]
extern "system" {
    fn MsiEnumPatchesA(
        szProduct: *const u8,  // LPCSTR
        iPatchIndex: u32,  // DWORD
        lpPatchBuf: *mut u8,  // LPSTR out
        lpTransformsBuf: *mut u8,  // LPSTR out
        pcchTransformsBuf: *mut u32  // DWORD* in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("msi.dll", CharSet = CharSet.Ansi)]
public static extern uint MsiEnumPatchesA([MarshalAs(UnmanagedType.LPStr)] string szProduct, uint iPatchIndex, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpPatchBuf, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpTransformsBuf, ref uint pcchTransformsBuf);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiEnumPatchesA' -Namespace Win32 -PassThru
# $api::MsiEnumPatchesA(szProduct, iPatchIndex, lpPatchBuf, lpTransformsBuf, pcchTransformsBuf)

#uselib "msi.dll"
#func global MsiEnumPatchesA "MsiEnumPatchesA" sptr, sptr, sptr, sptr, sptr
; MsiEnumPatchesA szProduct, iPatchIndex, varptr(lpPatchBuf), varptr(lpTransformsBuf), varptr(pcchTransformsBuf)   ; 戻り値は stat
; szProduct : LPCSTR -> "sptr"
; iPatchIndex : DWORD -> "sptr"
; lpPatchBuf : LPSTR out -> "sptr"
; lpTransformsBuf : LPSTR out -> "sptr"
; pcchTransformsBuf : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "msi.dll"
#cfunc global MsiEnumPatchesA "MsiEnumPatchesA" str, int, var, var, var
; res = MsiEnumPatchesA(szProduct, iPatchIndex, lpPatchBuf, lpTransformsBuf, pcchTransformsBuf)
; szProduct : LPCSTR -> "str"
; iPatchIndex : DWORD -> "int"
; lpPatchBuf : LPSTR out -> "var"
; lpTransformsBuf : LPSTR out -> "var"
; pcchTransformsBuf : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "msi.dll"
#cfunc global MsiEnumPatchesA "MsiEnumPatchesA" str, int, sptr, sptr, sptr
; res = MsiEnumPatchesA(szProduct, iPatchIndex, varptr(lpPatchBuf), varptr(lpTransformsBuf), varptr(pcchTransformsBuf))
; szProduct : LPCSTR -> "str"
; iPatchIndex : DWORD -> "int"
; lpPatchBuf : LPSTR out -> "sptr"
; lpTransformsBuf : LPSTR out -> "sptr"
; pcchTransformsBuf : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。