MsiGetSummaryInformationA 関数 (msiquery.h)

MsiGetSummaryInformation 関数は、インストーラー データベースの_SummaryInformation ストリームへのハンドルを取得します。 この関数は、MsiCloseHandleを使用して閉じる必要があるハンドルを返します。

構文

UINT MsiGetSummaryInformationA(
  [in]  MSIHANDLE hDatabase,
  [in]  LPCSTR    szDatabasePath,
  [in]  UINT      uiUpdateCount,
  [out] MSIHANDLE *phSummaryInfo
);

パラメーター

[in] hDatabase

データベースへのハンドル。

[in] szDatabasePath

データベースへのパスを指定します。

[in] uiUpdateCount

更新された値の最大数を指定します。

[out] phSummaryInfo

概要情報ハンドルを受け取る場所へのポインター。

戻り値

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

備考

MsiGetSummaryInformation 関数で指定されたデータベースが開かない場合は、hDatabase 0 を指定し、szDatabasePathでデータベースへのパスを指定する必要があります。 データベースが開いている場合は、szDatabasePath を 0 に設定する必要があります。

uiUpdateCount 0 より大きい値を使用して既存の概要情報ストリームを開く場合は、phSummaryInfo ハンドルを閉じる前に、msiSummaryInfoPersist を呼び出す必要があります。 これを行わないと、既存のストリーム情報が失われます。

MsiGetSummaryInformation使用してパッチの概要情報を表示するには、szDatabasePath をパッチへのパスに設定します。 または、MsiOpenDatabase を使用してパッチへのハンドルを作成し、そのハンドルを hDatabase パラメーターとして msiGetSummaryInformation 渡すことができます。

PMSIHANDLE 型の変数は、インストーラーがスコープ外に出ると PMSIHANDLE オブジェクトを閉じるのに対し、MSICloseHandleを呼び出して MSIHANDLE オブジェクト 閉じる必要があるため、PMSIHANDLE 型の変数を使用することをお勧めします。 詳細については、「Windows インストーラーのベスト プラクティス」の「HANDLE の代わりに PMSIHANDLE を使用する 」を参照してください。

関数が失敗した場合は、MsiGetLastErrorRecordを使用して拡張エラー情報を取得できます。

手記

msiquery.h ヘッダーは、MSIGetSummaryInformation を、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 インストーラー
ターゲット プラットフォーム の	ウィンドウズ
ヘッダー	msiquery.h
ライブラリ	Msi.lib
DLL	Msi.dll

関連項目

Summary Information プロパティ関数

Summary Information Stream プロパティ セット