MsiGetPatchFileListA 関数 (msi.h)

  • [アーティクル]

MsiGetPatchFileList 関数には、セミコロンで区切られた .msp ファイルの一覧が提供され、パッチによって更新できるファイルの一覧が取得されます。

構文

UINT MsiGetPatchFileListA(
  [in]      LPCSTR    szProductCode,
  [in]      LPCSTR    szPatchPackages,
  [in, out] LPDWORD   pcFiles,
  [in, out] MSIHANDLE **pphFileRecords
);

パラメーター

[in] szProductCode

パッチのターゲットである 製品の ProductCode (GUID) を含む null で終わる文字列値。 このパラメーターを NULL にすることはできません。

[in] szPatchPackages

Windows インストーラーの修正プログラム (.msp ファイル) の一覧を含む null で終わる文字列値。 各パッチは、パッチ パッケージへの完全パスで指定できます。 リスト内のパッチはセミコロンで区切られます。 少なくとも 1 つのパッチを指定する必要があります。

[in, out] pcFiles

szPatchList で指定されたパッチのこのリストによって、このシステムで更新されるファイルの数を受け取る場所へのポインター。 このパラメーターは必須です。

[in, out] pphFileRecords

レコードの配列へのポインターを受け取る場所へのポインター。 各レコードの最初のフィールド (0 インデックス) には、このコンピューターで szPatchList のパッチの一覧が適用されたときに更新できるファイルの完全なファイル パスが含まれています。 このパラメーターは必須です。

戻り値

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

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

解説

たとえば、 szPatchList の値は "c:\sus\download\cache\Office\sp1.msp;c:\sus\download\cache\Office\QFE1.msp;c:\sus\download\cache\Office\QFEn.msp"

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

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

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

MsiGetPatchFileList 関数の使用の詳細については、「更新可能なファイルの一覧表示」を参照してください。

注意

msi.h ヘッダーは、MSIGetPatchFileList をエイリアスとして定義し、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択します。 エンコードに依存しないエイリアスをエンコードニュートラルでないコードと組み合わせて使用すると、コンパイルまたはランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「 関数プロトタイプの規則」を参照してください。

要件

   
サポートされている最小のクライアント Windows Server 2012、Windows 8、Windows Server 2008 R2、または Windows 7 の Windows インストーラー 5.0。 Windows Server 2008 または Windows Vista の Windows インストーラー 4.0 または Windows インストーラー 4.5。 Windows Server 2003 および Windows XP の Windows インストーラー 4.5。 Windows インストーラーのバージョン別に必須となる最小 Windows サービス パックに関する詳細については、Windows インストーラーの実行時の要件に関する記事を参照してください。
対象プラットフォーム Windows
ヘッダー msi.h
Library Msi.lib
[DLL] Msi.dll

関連項目

Windows インストーラー 3.1 以前のバージョンではサポートされていません