MsiEnumPatchesA 関数 (msi.h)

MsiEnumPatches 関数は、製品に適用されているすべてのパッチを列挙します。 関数は、製品に適用されている各パッチのパッチ コード GUID を返し、製品に適用される各パッチからの変換の一覧を返します。 パッチには、特定の製品に適用できる変換の一部のみが含まれる場合があることに注意してください。 変換の一覧は、 TRANSFORMS プロパティの値と同じ形式で返されます。

pcchTransformsBuf は、MsiEnumPatches が正常に返された場合に lpTransformsBuf にコピーされた文字数に設定されません。
 

構文

UINT MsiEnumPatchesA(
  [in]      LPCSTR  szProduct,
  [in]      DWORD   iPatchIndex,
  [out]     LPSTR   lpPatchBuf,
  [out]     LPSTR   lpTransformsBuf,
  [in, out] LPDWORD pcchTransformsBuf
);

パラメーター

[in] szProduct

パッチを列挙する製品の製品コードを指定します。

[in] iPatchIndex

取得するパッチのインデックスを指定します。 このパラメーターは、 MsiEnumPatches 関数の最初の呼び出しでは 0 にし、その後の呼び出しではインクリメントする必要があります。

[out] lpPatchBuf

パッチの GUID を受け取るバッファーへのポインター。 この引数は必須です。

[out] lpTransformsBuf

製品に適用できるパッチ内の変換の一覧を受け取るバッファーへのポインター。 この引数は必須であり、Null にすることはできません。

[in, out] pcchTransformsBuf

関数が正常に戻されなかった場合に lpTransformsBuf にコピーされる文字数に設定します。 成功した戻り値に対して設定されていません。 入力時には、終端の null 文字のスペースを含む、バッファーのフルサイズです。 渡されたバッファーが小さすぎる場合、返されるカウントには終端の null 文字は含まれません。

戻り値

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

注釈

パッチを列挙するには、アプリケーションは最初に、iPatchIndex パラメーターを 0 に設定して MsiEnumPatches 関数を呼び出す必要があります。 その後、アプリケーションは iPatchIndex パラメーターをインクリメントし、(関数がERROR_NO_MORE_ITEMSを返すまで) 製品がなくなったら MsiEnumPatches を呼び出す必要があります。

バッファーが小さすぎて要求されたデータを保持しない場合、 MsiEnumPatches は ERROR_MORE_DATAを返し、 pcchTransformsBuf には null 文字をカウントせずに lpTransformsBuf にコピーされた文字数が含まれます。

注意

msi.h ヘッダーは、MSIEnumPatches をエイリアスとして定義し、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 インストーラー。 Windows インストーラーのバージョン別に必須となる最小 Windows サービス パックに関する詳細については、Windows インストーラーの実行時の要件に関する記事を参照してください。
対象プラットフォーム Windows
ヘッダー msi.h
Library Msi.lib
[DLL] Msi.dll