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 を指定します。 このパラメーターには、Summary Information Stream プロパティ セットにリストされているプロパティ ID を指定できます。 この関数は、PID_DICTIONARY OR PID_THUMBNAIL プロパティの値を返しません。
[out] puiDataType
返されたプロパティ型を受け取ります。 このパラメーターは、次に示す型にすることができます。
Summary Information Stream プロパティ セット。
[out] piValue
返された整数プロパティ データを受け取ります。
[out] pftValue
ファイル値へのポインター。
[out] szValueBuf
null 終端の概要情報プロパティ値を受け取るバッファーへのポインター。 szValueBufに null (値 =0) を渡してバッファーのサイズを決定しないでください。 空の文字列 (""など) を渡すことで、バッファーのサイズを取得できます。 次に、この関数はERROR_MORE_DATAを返し、pcchValueBuf は、終端の null 文字を含まない、TCHARに必要なバッファー サイズを含みます。 ERROR_SUCCESSが返された場合、pcchValueBuf には、バッファーに書き込まれた TCHAR の数が格納。終端の null 文字は含まれません。 エラーがない場合、このパラメーターは空の文字列です。
[in, out] pcchValueBuf
szValueBufの変数が指すバッファーのサイズ
戻り値
MsiSummaryInfoGetProperty 関数は、次のいずれかの値を返します。
備考
ERROR_MORE_DATAが返された場合、ポインターであるパラメーターは、文字列を保持するために必要なバッファーのサイズを指定します。 ERROR_SUCCESSが返された場合は、文字列バッファーに書き込まれた文字数が返されます。 そのため、バッファーを指定するパラメーターに空の文字列 ("") を渡すことで、バッファーのサイズを取得できます。 Null (値 = 0) を渡してバッファーのサイズを決定しないでください。
ユーザーが指定したメモリ位置のデータを返す Windows インストーラー関数は、ポインターの値として null で呼び出さないでください。 これらの関数は文字列を返すか、整数ポインターとしてデータを返しますが、出力引数の値として null を渡すと一貫性のない値が返されます。 詳細については、「Windows インストーラー関数の引数として null を渡す」を参照してください。
MsiSummaryInfoGetProperty 関数によって返されるプロパティ情報は、piValue、pftValue、または puiDataType パラメーターで指定されたプロパティ値の型に応じて、szValueBuf パラメーターによって受け取ります。
手記
msiquery.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI または Unicode バージョンを自動的に選択するエイリアスとして MsiSummaryInfoGetProperty を定義します。 エンコードに依存しないエイリアスをエンコードに依存しないコードと組み合わせて使用すると、コンパイルエラーやランタイム エラーが発生する不一致が発生する可能性があります。 詳細については、「関数プロトタイプの 規則」を参照してください。
必要条件
| 要件 | 価値 |
|---|---|
| サポートされる最小クライアント | 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 インストーラー |
| ターゲット プラットフォーム の |
ウィンドウズ |
| ヘッダー | msiquery.h |
| ライブラリ | Msi.lib |
| DLL | Msi.dll |
関連項目
windows インストーラー関数の引数として null を渡す