ホーム › System.ApplicationInstallationAndServicing › MsiSummaryInfoGetPropertyW

MsiSummaryInfoGetPropertyW

関数

サマリ情報の指定プロパティの型と値を取得する。

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

シグネチャ

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

DWORD MsiSummaryInfoGetPropertyW(
    MSIHANDLE hSummaryInfo,
    DWORD uiProperty,
    DWORD* puiDataType,
    INT* piValue,
    FILETIME* pftValue,   // optional
    LPWSTR szValueBuf,   // optional
    DWORD* pcchValueBuf   // optional
);

パラメーター

名前	型	方向	説明
hSummaryInfo	MSIHANDLE	in	サマリー情報へのハンドルです。
uiProperty	DWORD	in	サマリープロパティのプロパティ ID を指定します。このパラメーターには、Summary Information Stream Property Set に列挙されているプロパティ ID を指定できます。この関数は、PID_DICTIONARY または PID_THUMBNAIL プロパティの値は返しません。
puiDataType	DWORD*	out	返されるプロパティの型を受け取ります。このパラメーターには、 Summary Information Stream Property Set に列挙されている型を指定できます。
piValue	INT*	out	返される整数型のプロパティデータを受け取ります。
pftValue	FILETIME*	outoptional	ファイル値へのポインターです。
szValueBuf	LPWSTR	outoptional	null で終端されたサマリー情報プロパティ値を受け取るバッファーへのポインターです。szValueBuf に null(value=0)を渡してバッファーのサイズを取得しようとしないでください。バッファーのサイズは、空文字列(例: "")を渡すことで取得できます。その場合、関数は ERROR_MORE_DATA を返し、pcchValueBuf には終端の null 文字を含まない、必要なバッファーサイズが TCHAR 単位で格納されます。ERROR_SUCCESS が返された場合、pcchValueBuf には終端の null 文字を含まない、バッファーに書き込まれた TCHAR 数が格納されます。エラーがない場合、このパラメーターは空文字列になります。
pcchValueBuf	DWORD*	inoutoptional	変数 szValueBuf が指すバッファーのサイズを TCHAR 単位で指定する変数へのポインターです。関数が ERROR_SUCCESS を返す場合、この変数には終端の null 文字を含まない、szValueBuf にコピーされたデータのサイズが格納されます。szValueBuf が十分な大きさでない場合、関数は ERROR_MORE_DATA を返し、終端の null 文字を含まない必要なサイズを pcchValueBuf が指す変数に格納します。

戻り値の型: DWORD

公式ドキュメント

MsiSummaryInfoGetProperty 関数は、サマリー情報ストリームから単一のプロパティを取得します。(Unicode)

戻り値

MsiSummaryInfoGetProperty 関数は、次のいずれかの値を返します。

解説(Remarks)

ERROR_MORE_DATA が返された場合、ポインターであるパラメーターには文字列を保持するために必要なバッファーのサイズが格納されます。ERROR_SUCCESS が返された場合、文字列バッファーに書き込まれた文字数が格納されます。したがって、バッファーを指定するパラメーターに空文字列(例: "")を渡すことで、バッファーのサイズを取得できます。null(value=0)を渡してバッファーのサイズを取得しようとしないでください。

ユーザー指定のメモリ位置にデータを返す Windows Installer 関数は、ポインターの値として null を渡して呼び出してはいけません。これらの関数は文字列を返したり整数ポインターとしてデータを返したりしますが、出力引数の値として null を渡すと一貫性のない値を返します。詳細については、 Passing Null as the Argument of Windows Installer Functions を参照してください。

MsiSummaryInfoGetProperty 関数が返すプロパティ情報は、puiDataType パラメーターで指定されたプロパティ値の型に応じて、piValue、pftValue、または szValueBuf パラメーターで受け取られます。

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 MsiSummaryInfoGetPropertyW(
    MSIHANDLE hSummaryInfo,
    DWORD uiProperty,
    DWORD* puiDataType,
    INT* piValue,
    FILETIME* pftValue,   // optional
    LPWSTR szValueBuf,   // optional
    DWORD* pcchValueBuf   // optional
);

[DllImport("msi.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint MsiSummaryInfoGetPropertyW(
    uint hSummaryInfo,   // MSIHANDLE
    uint uiProperty,   // DWORD
    out uint puiDataType,   // DWORD* out
    out int piValue,   // INT* out
    IntPtr pftValue,   // FILETIME* optional, out
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder szValueBuf,   // LPWSTR optional, out
    IntPtr pcchValueBuf   // DWORD* optional, in/out
);

<DllImport("msi.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function MsiSummaryInfoGetPropertyW(
    hSummaryInfo As UInteger,   ' MSIHANDLE
    uiProperty As UInteger,   ' DWORD
    <Out> ByRef puiDataType As UInteger,   ' DWORD* out
    <Out> ByRef piValue As Integer,   ' INT* out
    pftValue As IntPtr,   ' FILETIME* optional, out
    <MarshalAs(UnmanagedType.LPWStr)> szValueBuf As System.Text.StringBuilder,   ' LPWSTR optional, out
    pcchValueBuf As IntPtr   ' DWORD* optional, in/out
) As UInteger
End Function

' hSummaryInfo : MSIHANDLE
' uiProperty : DWORD
' puiDataType : DWORD* out
' piValue : INT* out
' pftValue : FILETIME* optional, out
' szValueBuf : LPWSTR optional, out
' pcchValueBuf : DWORD* optional, in/out
Declare PtrSafe Function MsiSummaryInfoGetPropertyW Lib "msi" ( _
    ByVal hSummaryInfo As Long, _
    ByVal uiProperty As Long, _
    ByRef puiDataType As Long, _
    ByRef piValue As Long, _
    ByVal pftValue As LongPtr, _
    ByVal szValueBuf As LongPtr, _
    ByVal pcchValueBuf As LongPtr) 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

MsiSummaryInfoGetPropertyW = ctypes.windll.msi.MsiSummaryInfoGetPropertyW
MsiSummaryInfoGetPropertyW.restype = wintypes.DWORD
MsiSummaryInfoGetPropertyW.argtypes = [
    wintypes.DWORD,  # hSummaryInfo : MSIHANDLE
    wintypes.DWORD,  # uiProperty : DWORD
    ctypes.POINTER(wintypes.DWORD),  # puiDataType : DWORD* out
    ctypes.POINTER(ctypes.c_int),  # piValue : INT* out
    ctypes.c_void_p,  # pftValue : FILETIME* optional, out
    wintypes.LPWSTR,  # szValueBuf : LPWSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcchValueBuf : DWORD* optional, in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiSummaryInfoGetPropertyW = Fiddle::Function.new(
  lib['MsiSummaryInfoGetPropertyW'],
  [
    -Fiddle::TYPE_INT,  # hSummaryInfo : MSIHANDLE
    -Fiddle::TYPE_INT,  # uiProperty : DWORD
    Fiddle::TYPE_VOIDP,  # puiDataType : DWORD* out
    Fiddle::TYPE_VOIDP,  # piValue : INT* out
    Fiddle::TYPE_VOIDP,  # pftValue : FILETIME* optional, out
    Fiddle::TYPE_VOIDP,  # szValueBuf : LPWSTR optional, out
    Fiddle::TYPE_VOIDP,  # pcchValueBuf : DWORD* optional, in/out
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "msi")]
extern "system" {
    fn MsiSummaryInfoGetPropertyW(
        hSummaryInfo: u32,  // MSIHANDLE
        uiProperty: u32,  // DWORD
        puiDataType: *mut u32,  // DWORD* out
        piValue: *mut i32,  // INT* out
        pftValue: *mut FILETIME,  // FILETIME* optional, out
        szValueBuf: *mut u16,  // LPWSTR optional, out
        pcchValueBuf: *mut u32  // DWORD* optional, in/out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("msi.dll", CharSet = CharSet.Unicode)]
public static extern uint MsiSummaryInfoGetPropertyW(uint hSummaryInfo, uint uiProperty, out uint puiDataType, out int piValue, IntPtr pftValue, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder szValueBuf, IntPtr pcchValueBuf);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiSummaryInfoGetPropertyW' -Namespace Win32 -PassThru
# $api::MsiSummaryInfoGetPropertyW(hSummaryInfo, uiProperty, puiDataType, piValue, pftValue, szValueBuf, pcchValueBuf)

#uselib "msi.dll"
#func global MsiSummaryInfoGetPropertyW "MsiSummaryInfoGetPropertyW" wptr, wptr, wptr, wptr, wptr, wptr, wptr
; MsiSummaryInfoGetPropertyW hSummaryInfo, uiProperty, varptr(puiDataType), varptr(piValue), varptr(pftValue), varptr(szValueBuf), varptr(pcchValueBuf)   ; 戻り値は stat
; hSummaryInfo : MSIHANDLE -> "wptr"
; uiProperty : DWORD -> "wptr"
; puiDataType : DWORD* out -> "wptr"
; piValue : INT* out -> "wptr"
; pftValue : FILETIME* optional, out -> "wptr"
; szValueBuf : LPWSTR optional, out -> "wptr"
; pcchValueBuf : DWORD* optional, in/out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "msi.dll"
#cfunc global MsiSummaryInfoGetPropertyW "MsiSummaryInfoGetPropertyW" int, int, var, var, var, var, var
; res = MsiSummaryInfoGetPropertyW(hSummaryInfo, uiProperty, puiDataType, piValue, pftValue, szValueBuf, pcchValueBuf)
; hSummaryInfo : MSIHANDLE -> "int"
; uiProperty : DWORD -> "int"
; puiDataType : DWORD* out -> "var"
; piValue : INT* out -> "var"
; pftValue : FILETIME* optional, out -> "var"
; szValueBuf : LPWSTR optional, out -> "var"
; pcchValueBuf : DWORD* optional, in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "msi.dll"
#cfunc global MsiSummaryInfoGetPropertyW "MsiSummaryInfoGetPropertyW" int, int, sptr, sptr, sptr, sptr, sptr
; res = MsiSummaryInfoGetPropertyW(hSummaryInfo, uiProperty, varptr(puiDataType), varptr(piValue), varptr(pftValue), varptr(szValueBuf), varptr(pcchValueBuf))
; hSummaryInfo : MSIHANDLE -> "int"
; uiProperty : DWORD -> "int"
; puiDataType : DWORD* out -> "sptr"
; piValue : INT* out -> "sptr"
; pftValue : FILETIME* optional, out -> "sptr"
; szValueBuf : LPWSTR optional, out -> "sptr"
; pcchValueBuf : DWORD* optional, in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。