ホーム › System.ApplicationInstallationAndServicing › MsiGetSummaryInformationW

MsiGetSummaryInformationW

関数

データベースのサマリ情報ストリームを開いてハンドルを取得する。

DLLmsi.dll文字セットUnicode (-W)呼出規約winapi対応OSwindows8.0

シグネチャ

// msi.dll  (Unicode / -W)
#include <windows.h>

DWORD MsiGetSummaryInformationW(
    MSIHANDLE hDatabase,
    LPCWSTR szDatabasePath,
    DWORD uiUpdateCount,
    MSIHANDLE* phSummaryInfo
);

パラメーター

名前	型	方向	説明
hDatabase	MSIHANDLE	in	データベースへのハンドル。
szDatabasePath	LPCWSTR	in	データベースへのパスを指定します。
uiUpdateCount	DWORD	in	更新される値の最大数を指定します。
phSummaryInfo	MSIHANDLE*	inout	概要情報ハンドルを受け取る場所へのポインター。

戻り値の型: DWORD

公式ドキュメント

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

戻り値

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

解説(Remarks)

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

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

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

インストーラーは PMSIHANDLE オブジェクトがスコープ外になると自動的に閉じるのに対し、MSIHANDLE オブジェクトは MsiCloseHandle を呼び出して閉じる必要があるため、PMSIHANDLE 型の変数を使用することが推奨されます。詳細については、Windows インストーラーのベストプラクティスの HANDLE の代わりに PMSIHANDLE を使用するセクションを参照してください。

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

メモ

msiquery.h ヘッダーは、MsiGetSummaryInformation を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義しています。エンコーディング中立のエイリアスの使用を、エンコーディング中立ではないコードと混在させると、不一致が発生し、コンパイルエラーまたは実行時エラーを引き起こす可能性があります。詳細については、関数プロトタイプの規則を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// msi.dll  (Unicode / -W)
#include <windows.h>

DWORD MsiGetSummaryInformationW(
    MSIHANDLE hDatabase,
    LPCWSTR szDatabasePath,
    DWORD uiUpdateCount,
    MSIHANDLE* phSummaryInfo
);

[DllImport("msi.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint MsiGetSummaryInformationW(
    uint hDatabase,   // MSIHANDLE
    [MarshalAs(UnmanagedType.LPWStr)] string szDatabasePath,   // LPCWSTR
    uint uiUpdateCount,   // DWORD
    ref uint phSummaryInfo   // MSIHANDLE* in/out
);

<DllImport("msi.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function MsiGetSummaryInformationW(
    hDatabase As UInteger,   ' MSIHANDLE
    <MarshalAs(UnmanagedType.LPWStr)> szDatabasePath As String,   ' LPCWSTR
    uiUpdateCount As UInteger,   ' DWORD
    ByRef phSummaryInfo As UInteger   ' MSIHANDLE* in/out
) As UInteger
End Function

' hDatabase : MSIHANDLE
' szDatabasePath : LPCWSTR
' uiUpdateCount : DWORD
' phSummaryInfo : MSIHANDLE* in/out
Declare PtrSafe Function MsiGetSummaryInformationW Lib "msi" ( _
    ByVal hDatabase As Long, _
    ByVal szDatabasePath As LongPtr, _
    ByVal uiUpdateCount As Long, _
    ByRef phSummaryInfo As Long) As Long
' Unicode(W): 文字列は ByVal As LongPtr とし StrPtr(unicodeStr) を渡す
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

MsiGetSummaryInformationW = ctypes.windll.msi.MsiGetSummaryInformationW
MsiGetSummaryInformationW.restype = wintypes.DWORD
MsiGetSummaryInformationW.argtypes = [
    wintypes.DWORD,  # hDatabase : MSIHANDLE
    wintypes.LPCWSTR,  # szDatabasePath : LPCWSTR
    wintypes.DWORD,  # uiUpdateCount : DWORD
    ctypes.c_void_p,  # phSummaryInfo : MSIHANDLE* in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiGetSummaryInformationW = Fiddle::Function.new(
  lib['MsiGetSummaryInformationW'],
  [
    -Fiddle::TYPE_INT,  # hDatabase : MSIHANDLE
    Fiddle::TYPE_VOIDP,  # szDatabasePath : LPCWSTR
    -Fiddle::TYPE_INT,  # uiUpdateCount : DWORD
    Fiddle::TYPE_VOIDP,  # phSummaryInfo : MSIHANDLE* in/out
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "msi")]
extern "system" {
    fn MsiGetSummaryInformationW(
        hDatabase: u32,  // MSIHANDLE
        szDatabasePath: *const u16,  // LPCWSTR
        uiUpdateCount: u32,  // DWORD
        phSummaryInfo: *mut u32  // MSIHANDLE* in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("msi.dll", CharSet = CharSet.Unicode)]
public static extern uint MsiGetSummaryInformationW(uint hDatabase, [MarshalAs(UnmanagedType.LPWStr)] string szDatabasePath, uint uiUpdateCount, ref uint phSummaryInfo);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiGetSummaryInformationW' -Namespace Win32 -PassThru
# $api::MsiGetSummaryInformationW(hDatabase, szDatabasePath, uiUpdateCount, phSummaryInfo)

#uselib "msi.dll"
#func global MsiGetSummaryInformationW "MsiGetSummaryInformationW" wptr, wptr, wptr, wptr
; MsiGetSummaryInformationW hDatabase, szDatabasePath, uiUpdateCount, varptr(phSummaryInfo)   ; 戻り値は stat
; hDatabase : MSIHANDLE -> "wptr"
; szDatabasePath : LPCWSTR -> "wptr"
; uiUpdateCount : DWORD -> "wptr"
; phSummaryInfo : MSIHANDLE* in/out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "msi.dll"
#cfunc global MsiGetSummaryInformationW "MsiGetSummaryInformationW" int, wstr, int, var
; res = MsiGetSummaryInformationW(hDatabase, szDatabasePath, uiUpdateCount, phSummaryInfo)
; hDatabase : MSIHANDLE -> "int"
; szDatabasePath : LPCWSTR -> "wstr"
; uiUpdateCount : DWORD -> "int"
; phSummaryInfo : MSIHANDLE* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "msi.dll"
#cfunc global MsiGetSummaryInformationW "MsiGetSummaryInformationW" int, wstr, int, sptr
; res = MsiGetSummaryInformationW(hDatabase, szDatabasePath, uiUpdateCount, varptr(phSummaryInfo))
; hDatabase : MSIHANDLE -> "int"
; szDatabasePath : LPCWSTR -> "wstr"
; uiUpdateCount : DWORD -> "int"
; phSummaryInfo : MSIHANDLE* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。