MsiGetSummaryInformationW 関数 (msiquery.h)

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

構文

UINT MsiGetSummaryInformationW(
  [in]  MSIHANDLE hDatabase,
  [in]  LPCWSTR   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 バージョンを自動的に選択します。 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

こちらもご覧ください

概要情報プロパティ関数

概要情報ストリームのプロパティ セット