MsiGetProductPropertyA 関数 (msi.h)

  • [アーティクル]

MsiGetProductProperty 関数は、製品プロパティを取得します。 これらのプロパティは、製品データベースにあります。

構文

UINT MsiGetProductPropertyA(
  [in]      MSIHANDLE hProduct,
  [in]      LPCSTR    szProperty,
  [out]     LPSTR     lpValueBuf,
  [in, out] LPDWORD   pcchValueBuf
);

パラメーター

[in] hProduct

MsiOpenProduct から取得した製品を処理します。

[in] szProperty

取得するプロパティを指定します。 これは大文字小文字を区別します。

[out] lpValueBuf

プロパティ値を受け取るバッファーへのポインター。 lpValueBuf が小さすぎる場合、値は切り捨てられ、null で終了します。 このパラメーターには、null を指定できます。

[in, out] pcchValueBuf

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

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

戻り値

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

値 意味
ERROR_INVALID_PARAMETER
 無効なパラメーターが関数に渡されました。
ERROR_INVALID_HANDLE
 無効なハンドルが関数に渡されました。
ERROR_MORE_DATA
 バッファーが小さすぎて、プロパティ値全体を保持できません。
ERROR_SUCCESS
 関数は正常に終了しました。
 
 

注釈

MsiGetProductProperty 関数が戻るとき、pcchValueBuf パラメーターにはバッファーに格納されている文字列の長さが含まれます。 返されるカウントには、終端の null 文字は含まれません。 バッファーの大きさが十分でない場合、 MsiGetProductProperty はERROR_MORE_DATAを返し、 MsiGetProductProperty には文字列のサイズが文字単位で格納され、null 文字はカウントされません。

注意

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

要件

要件 値
サポートされている最小のクライアント 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

こちらもご覧ください

製品クエリ関数