MsiGetPatchInfoA 関数 (msi.h)

  • [アーティクル]

MsiGetPatchInfo 関数は、パッチに関する情報を返します。

構文

UINT MsiGetPatchInfoA(
  [in]      LPCSTR  szPatch,
  [in]      LPCSTR  szAttribute,
  [out]     LPSTR   lpValueBuf,
  [in, out] LPDWORD pcchValueBuf
);

パラメーター

[in] szPatch

パッチ パッケージのパッチ コードを指定します。

[in] szAttribute

取得する属性を指定します。

属性 説明
INSTALLPROPERTY_LOCALPACKAGE
 ローカルにキャッシュされたパッケージ。

[out] lpValueBuf

プロパティ値を受け取るバッファーへのポインター。 このパラメーターには、null を指定できます。

[in, out] pcchValueBuf

lpValueBuf パラメーターが指すバッファーのサイズを文字数で指定する変数へのポインター。 入力時には、終端の null 文字のスペースを含む、バッファーのフルサイズです。 渡されたバッファーが小さすぎる場合、返されるカウントには終端の null 文字は含まれません。

lpValueBuf が null の場合、pcchValueBuf は null にすることができます。

戻り値

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

値 説明
ERROR_BAD_CONFIGURATION
 構成データが破損しています。
ERROR_INVALID_PARAMETER
 無効なパラメーターが関数に渡されました。
ERROR_MORE_DATA
 バッファーが小さすぎて、要求されたデータを保持できません。
ERROR_SUCCESS
 関数は正常に終了しました。
ERROR_UNKNOWN_PRODUCT
 パッチ パッケージがインストールされていません。
ERROR_UNKNOWN_PROPERTY
 プロパティが認識されません。
 
 

解説

MsiGetPatchInfo 関数が返されると、pcchValueBuf パラメーターには、バッファーに格納されているクラス文字列の長さが含まれます。 返されるカウントには、終端の null 文字は含まれません。

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

注意

msi.h ヘッダーは、MSIGetPatchInfo をエイリアスとして定義し、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

関連項目

Windows インストーラー 2.0 以前ではサポートされていません