ホーム › System.ApplicationInstallationAndServicing › MsiGetPatchFileListA

MsiGetPatchFileListA

関数

パッチパッケージが変更するファイルの一覧をレコードとして取得する。

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

シグネチャ

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

DWORD MsiGetPatchFileListA(
    LPCSTR szProductCode,
    LPCSTR szPatchPackages,
    DWORD* pcFiles,
    MSIHANDLE** pphFileRecords
);

パラメーター

名前	型	方向	説明
szProductCode	LPCSTR	in	パッチの対象となる製品の ProductCode(GUID)を格納した、null で終わる文字列値です。このパラメーターを NULL にすることはできません。
szPatchPackages	LPCSTR	in	Windows Installer のパッチ(.msp ファイル)のリストを格納した、null で終わる文字列値です。各パッチはパッチパッケージへのフルパスで指定できます。リスト内のパッチはセミコロンで区切ります。少なくとも 1 つのパッチを指定する必要があります。
pcFiles	DWORD*	out	szPatchList で指定されたパッチのリストによって、このシステム上で更新されるファイルの数を受け取る場所へのポインターです。このパラメーターは必須です。
pphFileRecords	MSIHANDLE**	out	レコードの配列へのポインターを受け取る場所へのポインターです。各レコードの最初のフィールド(インデックス 0)には、szPatchList 内のパッチのリストがこのコンピューター上で適用されたときに更新可能なファイルのフルパスが格納されます。このパラメーターは必須です。

戻り値の型: DWORD

公式ドキュメント

MsiGetPatchFileList 関数は、セミコロンで区切られた .msp ファイルのリストを受け取り、それらのパッチによって更新可能なファイルの一覧を取得します。(ANSI)

戻り値

MsiGetPatchFileList 関数は、次の値を返します。

値	意味
ERROR_SUCCESS	関数は正常に完了しました。
ERROR_INVALID_PARAMETER	無効なパラメーターが関数に渡されました。
ERROR_FUNCTION_FAILED	関数が失敗しました。

解説(Remarks)

たとえば、szPatchList には次のような値を指定できます: "c:\sus\download\cache\Office\sp1.msp; c:\sus\download\cache\Office\QFE1.msp; c:\sus\download\cache\Office\QFEn.msp"。

この関数は呼び出し元のコンテキストで実行されます。製品コードは、ユーザー非管理コンテキスト、ユーザー管理コンテキスト、マシンコンテキストの順に検索されます。

この関数によって返されるすべての MSIHANDLE オブジェクトは、MsiCloseHandle 関数を呼び出して閉じる必要があります。

関数が失敗した場合は、MsiGetLastErrorRecord 関数を使用して拡張エラー情報を取得できます。

MsiGetPatchFileList 関数の使用方法の詳細については、Listing the Files that can be Updated を参照してください。

メモ

msi.h ヘッダーは MsiGetPatchFileList を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義します。エンコーディング非依存のエイリアスを、エンコーディング非依存ではないコードと混在させて使用すると、不一致が生じてコンパイルエラーや実行時エラーの原因となることがあります。詳細については、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 MsiGetPatchFileListA(
    LPCSTR szProductCode,
    LPCSTR szPatchPackages,
    DWORD* pcFiles,
    MSIHANDLE** pphFileRecords
);

[DllImport("msi.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint MsiGetPatchFileListA(
    [MarshalAs(UnmanagedType.LPStr)] string szProductCode,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string szPatchPackages,   // LPCSTR
    out uint pcFiles,   // DWORD* out
    IntPtr pphFileRecords   // MSIHANDLE** out
);

<DllImport("msi.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function MsiGetPatchFileListA(
    <MarshalAs(UnmanagedType.LPStr)> szProductCode As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> szPatchPackages As String,   ' LPCSTR
    <Out> ByRef pcFiles As UInteger,   ' DWORD* out
    pphFileRecords As IntPtr   ' MSIHANDLE** out
) As UInteger
End Function

' szProductCode : LPCSTR
' szPatchPackages : LPCSTR
' pcFiles : DWORD* out
' pphFileRecords : MSIHANDLE** out
Declare PtrSafe Function MsiGetPatchFileListA Lib "msi" ( _
    ByVal szProductCode As String, _
    ByVal szPatchPackages As String, _
    ByRef pcFiles As Long, _
    ByVal pphFileRecords As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

MsiGetPatchFileListA = ctypes.windll.msi.MsiGetPatchFileListA
MsiGetPatchFileListA.restype = wintypes.DWORD
MsiGetPatchFileListA.argtypes = [
    wintypes.LPCSTR,  # szProductCode : LPCSTR
    wintypes.LPCSTR,  # szPatchPackages : LPCSTR
    ctypes.POINTER(wintypes.DWORD),  # pcFiles : DWORD* out
    ctypes.c_void_p,  # pphFileRecords : MSIHANDLE** out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiGetPatchFileListA = Fiddle::Function.new(
  lib['MsiGetPatchFileListA'],
  [
    Fiddle::TYPE_VOIDP,  # szProductCode : LPCSTR
    Fiddle::TYPE_VOIDP,  # szPatchPackages : LPCSTR
    Fiddle::TYPE_VOIDP,  # pcFiles : DWORD* out
    Fiddle::TYPE_VOIDP,  # pphFileRecords : MSIHANDLE** out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "msi")]
extern "system" {
    fn MsiGetPatchFileListA(
        szProductCode: *const u8,  // LPCSTR
        szPatchPackages: *const u8,  // LPCSTR
        pcFiles: *mut u32,  // DWORD* out
        pphFileRecords: *mut *mut u32  // MSIHANDLE** out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("msi.dll", CharSet = CharSet.Ansi)]
public static extern uint MsiGetPatchFileListA([MarshalAs(UnmanagedType.LPStr)] string szProductCode, [MarshalAs(UnmanagedType.LPStr)] string szPatchPackages, out uint pcFiles, IntPtr pphFileRecords);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiGetPatchFileListA' -Namespace Win32 -PassThru
# $api::MsiGetPatchFileListA(szProductCode, szPatchPackages, pcFiles, pphFileRecords)

#uselib "msi.dll"
#func global MsiGetPatchFileListA "MsiGetPatchFileListA" sptr, sptr, sptr, sptr
; MsiGetPatchFileListA szProductCode, szPatchPackages, varptr(pcFiles), varptr(pphFileRecords)   ; 戻り値は stat
; szProductCode : LPCSTR -> "sptr"
; szPatchPackages : LPCSTR -> "sptr"
; pcFiles : DWORD* out -> "sptr"
; pphFileRecords : MSIHANDLE** out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "msi.dll"
#cfunc global MsiGetPatchFileListA "MsiGetPatchFileListA" str, str, var, var
; res = MsiGetPatchFileListA(szProductCode, szPatchPackages, pcFiles, pphFileRecords)
; szProductCode : LPCSTR -> "str"
; szPatchPackages : LPCSTR -> "str"
; pcFiles : DWORD* out -> "var"
; pphFileRecords : MSIHANDLE** out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "msi.dll"
#cfunc global MsiGetPatchFileListA "MsiGetPatchFileListA" str, str, sptr, sptr
; res = MsiGetPatchFileListA(szProductCode, szPatchPackages, varptr(pcFiles), varptr(pphFileRecords))
; szProductCode : LPCSTR -> "str"
; szPatchPackages : LPCSTR -> "str"
; pcFiles : DWORD* out -> "sptr"
; pphFileRecords : MSIHANDLE** out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。