ホーム › System.ApplicationInstallationAndServicing › MsiGetPatchFileListW

MsiGetPatchFileListW

関数

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

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

シグネチャ

// msi.dll  (Unicode / -W)
#include <windows.h>

DWORD MsiGetPatchFileListW(
    LPCWSTR szProductCode,
    LPCWSTR szPatchPackages,
    DWORD* pcFiles,
    MSIHANDLE** pphFileRecords
);

パラメーター

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

戻り値の型: DWORD

公式ドキュメント

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

戻り値

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

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

各言語での呼び出し定義

// msi.dll  (Unicode / -W)
#include <windows.h>

DWORD MsiGetPatchFileListW(
    LPCWSTR szProductCode,
    LPCWSTR szPatchPackages,
    DWORD* pcFiles,
    MSIHANDLE** pphFileRecords
);

[DllImport("msi.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint MsiGetPatchFileListW(
    [MarshalAs(UnmanagedType.LPWStr)] string szProductCode,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string szPatchPackages,   // LPCWSTR
    out uint pcFiles,   // DWORD* out
    IntPtr pphFileRecords   // MSIHANDLE** out
);

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

' szProductCode : LPCWSTR
' szPatchPackages : LPCWSTR
' pcFiles : DWORD* out
' pphFileRecords : MSIHANDLE** out
Declare PtrSafe Function MsiGetPatchFileListW Lib "msi" ( _
    ByVal szProductCode As LongPtr, _
    ByVal szPatchPackages As LongPtr, _
    ByRef pcFiles As Long, _
    ByVal pphFileRecords As LongPtr) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

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

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiGetPatchFileListW = Fiddle::Function.new(
  lib['MsiGetPatchFileListW'],
  [
    Fiddle::TYPE_VOIDP,  # szProductCode : LPCWSTR
    Fiddle::TYPE_VOIDP,  # szPatchPackages : LPCWSTR
    Fiddle::TYPE_VOIDP,  # pcFiles : DWORD* out
    Fiddle::TYPE_VOIDP,  # pphFileRecords : MSIHANDLE** out
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "msi")]
extern "system" {
    fn MsiGetPatchFileListW(
        szProductCode: *const u16,  // LPCWSTR
        szPatchPackages: *const u16,  // LPCWSTR
        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.Unicode)]
public static extern uint MsiGetPatchFileListW([MarshalAs(UnmanagedType.LPWStr)] string szProductCode, [MarshalAs(UnmanagedType.LPWStr)] string szPatchPackages, out uint pcFiles, IntPtr pphFileRecords);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiGetPatchFileListW' -Namespace Win32 -PassThru
# $api::MsiGetPatchFileListW(szProductCode, szPatchPackages, pcFiles, pphFileRecords)

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

出力引数:

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