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 が小さすぎると、値
[in, out] pcchValueBuf
lpValueBuf パラメーターが指すバッファーのサイズを文字で指定する変数へのポインター。 入力時には、これはバッファーのフル サイズであり、終端の null 文字のスペースも含まれます。 渡されたバッファーが小さすぎる場合、返されるカウントには終端の null 文字は含まれません。
lpValueBuf
戻り値
MsiGetProductProperty 関数は、次の値を返します。
| 価値 | 意味 |
|---|---|
|
無効なパラメーターが関数に渡されました。 |
|
無効なハンドルが関数に渡されました。 |
|
バッファーが小さすぎて、プロパティ値全体を保持できません。 |
|
関数は正常に完了しました。 |
備考
MsiGetProductProperty 関数が返されると、pcchValueBuf パラメーターには、バッファーに格納されている文字列の長さが含まれます。 返されるカウントには、終端の null 文字は含まれません。 バッファーのサイズが十分でない場合は、MsiGetProductProperty はERROR_MORE_DATAを返し、MsiGetProductProperty には、null 文字をカウントせずに文字列のサイズが文字で格納されます。
手記
msi.h ヘッダーは、MSIGetProductProperty を、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 Service Pack の詳細については、Windows インストーラーの Run-Time 要件を参照してください。 |
| ターゲット プラットフォーム の |
ウィンドウズ |
| ヘッダー | msi.h |
| ライブラリ | Msi.lib |
| DLL | Msi.dll |