MsiSummaryInfoGetPropertyA 関数 (msiquery.h)
MsiSummaryInfoGetProperty 関数は、概要情報ストリームから 1 つのプロパティを取得します。
構文
UINT MsiSummaryInfoGetPropertyA(
[in] MSIHANDLE hSummaryInfo,
[in] UINT uiProperty,
[out] PUINT puiDataType,
[out] LPINT piValue,
[out] FILETIME *pftValue,
[out] LPSTR szValueBuf,
[in, out] LPDWORD pcchValueBuf
);
パラメーター
[in] hSummaryInfo
概要情報を処理します。
[in] uiProperty
サマリー プロパティのプロパティ ID を指定します。 このパラメーターには、[概要情報] Stream [プロパティ セット] に一覧表示されているプロパティ ID を指定できます。 この関数は、PID_DICTIONARY OR PID_THUMBNAIL プロパティの値を返しません。
[out] puiDataType
返されたプロパティの種類を受け取ります。 このパラメーターには、 に一覧表示されている型を指定できます。
プロパティ セットStream概要情報。
[out] piValue
返された整数プロパティ データを受け取ります。
[out] pftValue
ファイル値へのポインター。
[out] szValueBuf
null 終了の概要情報プロパティ値を受け取るバッファーへのポインター。 szValueBuf に null (value=0) を渡してバッファーのサイズを決定しないでください。 空の文字列 (""など) を渡すことで、バッファーのサイズを取得できます。 次に、この関数は ERROR_MORE_DATAを返し、 pcchValueBuf には TCHAR に必要なバッファー サイズが含まれており、終端の null 文字は含まれません。 ERROR_SUCCESS返された pcchValueBuf には、バッファーに書き込まれた TCHAR の 数が含まれ、終端の null 文字は含まれません。 エラーがない場合、このパラメーターは空の文字列です。
[in, out] pcchValueBuf
変数 szValueBuf によって指されるバッファーのサイズを TCHAR で指定する変数へのポインター。 関数がERROR_SUCCESSを返すとき、この変数には 、szValueBuf にコピーされたデータのサイズが含まれます。終端の null 文字は含まれません。 szValueBuf が十分な大きさでない場合、関数は ERROR_MORE_DATAを返し、pcchValueBuf が指す変数に、終端の null 文字を含まない必要なサイズを格納します。
戻り値
MsiSummaryInfoGetProperty 関数は、次のいずれかの値を返します。
注釈
ERROR_MORE_DATAが返された場合、ポインターである パラメーターは、文字列を保持するために必要なバッファーのサイズを示します。 ERROR_SUCCESSが返された場合は、文字列バッファーに書き込まれた文字数が返されます。 そのため、バッファーを指定するパラメーターに空の文字列 (""など) を渡すことで、バッファーのサイズを取得できます。 Null (値=0) を渡してバッファーのサイズを決定しないでください。
ユーザーが指定したメモリ位置のデータを返す Windows インストーラー関数は、ポインターの値として null を指定して呼び出さないでください。 このような関数は、文字列を返すか、整数ポインターとしてデータを返しますが、出力引数の値として null を渡すと、一貫性のない値を返します。 詳細については、「 Windows インストーラー関数の引数として Null を渡す」を参照してください。
MsiSummaryInfoGetProperty 関数によって返されるプロパティ情報は、puiDataType パラメーターで指定されているプロパティ値の種類に応じて、piValue、pftValue、または szValueBuf パラメーターによって受け取られます。
注意
msiquery.h ヘッダーは、MSISummaryInfoGetProperty をエイリアスとして定義し、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 |
| ヘッダー | msiquery.h |
| Library | Msi.lib |
| [DLL] | Msi.dll |