ホーム › System.ApplicationInstallationAndServicing › MsiGetProductPropertyW

MsiGetProductPropertyW

関数

開いた製品ハンドルから指定プロパティの値を取得する。

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

シグネチャ

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

DWORD MsiGetProductPropertyW(
    MSIHANDLE hProduct,
    LPCWSTR szProperty,
    LPWSTR lpValueBuf,   // optional
    DWORD* pcchValueBuf   // optional
);

パラメーター

名前	型	方向	説明
hProduct	MSIHANDLE	in	MsiOpenProduct から取得した製品のハンドル。
szProperty	LPCWSTR	in	取得するプロパティを指定します。大文字と小文字が区別されます。
lpValueBuf	LPWSTR	outoptional	プロパティ値を受け取るバッファーへのポインター。lpValueBuf が小さすぎる場合、値は切り詰められ、null で終端されます。このパラメーターは null を指定できます。
pcchValueBuf	DWORD*	inoutoptional	lpValueBuf パラメーターが指すバッファーのサイズ(文字数)を指定する変数へのポインター。入力時には、終端の null 文字分の領域を含むバッファーの全サイズを指定します。渡したバッファーが小さすぎる場合、返される文字数には終端の null 文字は含まれません。 lpValueBuf が null の場合、pcchValueBuf は null を指定できます。

戻り値の型: DWORD

公式ドキュメント

MsiGetProductProperty 関数は、製品のプロパティを取得します。これらのプロパティは製品データベースに格納されています。(Unicode)

戻り値

                <b>MsiGetProductProperty</b> 関数は、次の値を返します。

値	意味
ERROR_INVALID_PARAMETER	無効なパラメーターが関数に渡されました。
ERROR_INVALID_HANDLE	無効なハンドルが関数に渡されました。
ERROR_MORE_DATA	プロパティ値全体を格納するにはバッファーが小さすぎます。
ERROR_SUCCESS	関数は正常に完了しました。

解説(Remarks)

MsiGetProductProperty 関数が返ると、pcchValueBuf パラメーターにはバッファーに格納された文字列の長さが入ります。返される文字数には終端の null 文字は含まれません。バッファーが十分な大きさでない場合、 MsiGetProductProperty は ERROR_MORE_DATA を返し、 MsiGetProductProperty には null 文字を数えない文字列のサイズ(文字数)が入ります。

メモ

msi.h ヘッダーは MsiGetProductProperty を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義します。エンコーディングに依存しないこのエイリアスの使用を、エンコーディングに依存しないわけではないコードと混在させると、コンパイルエラーや実行時エラーを引き起こす不整合につながる可能性があります。詳細については、「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 MsiGetProductPropertyW(
    MSIHANDLE hProduct,
    LPCWSTR szProperty,
    LPWSTR lpValueBuf,   // optional
    DWORD* pcchValueBuf   // optional
);

[DllImport("msi.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint MsiGetProductPropertyW(
    uint hProduct,   // MSIHANDLE
    [MarshalAs(UnmanagedType.LPWStr)] string szProperty,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpValueBuf,   // LPWSTR optional, out
    IntPtr pcchValueBuf   // DWORD* optional, in/out
);

<DllImport("msi.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function MsiGetProductPropertyW(
    hProduct As UInteger,   ' MSIHANDLE
    <MarshalAs(UnmanagedType.LPWStr)> szProperty As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> lpValueBuf As System.Text.StringBuilder,   ' LPWSTR optional, out
    pcchValueBuf As IntPtr   ' DWORD* optional, in/out
) As UInteger
End Function

' hProduct : MSIHANDLE
' szProperty : LPCWSTR
' lpValueBuf : LPWSTR optional, out
' pcchValueBuf : DWORD* optional, in/out
Declare PtrSafe Function MsiGetProductPropertyW Lib "msi" ( _
    ByVal hProduct As Long, _
    ByVal szProperty As LongPtr, _
    ByVal lpValueBuf 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

MsiGetProductPropertyW = ctypes.windll.msi.MsiGetProductPropertyW
MsiGetProductPropertyW.restype = wintypes.DWORD
MsiGetProductPropertyW.argtypes = [
    wintypes.DWORD,  # hProduct : MSIHANDLE
    wintypes.LPCWSTR,  # szProperty : LPCWSTR
    wintypes.LPWSTR,  # lpValueBuf : LPWSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcchValueBuf : DWORD* optional, in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiGetProductPropertyW = Fiddle::Function.new(
  lib['MsiGetProductPropertyW'],
  [
    -Fiddle::TYPE_INT,  # hProduct : MSIHANDLE
    Fiddle::TYPE_VOIDP,  # szProperty : LPCWSTR
    Fiddle::TYPE_VOIDP,  # lpValueBuf : 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 MsiGetProductPropertyW(
        hProduct: u32,  // MSIHANDLE
        szProperty: *const u16,  // LPCWSTR
        lpValueBuf: *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 MsiGetProductPropertyW(uint hProduct, [MarshalAs(UnmanagedType.LPWStr)] string szProperty, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpValueBuf, IntPtr pcchValueBuf);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiGetProductPropertyW' -Namespace Win32 -PassThru
# $api::MsiGetProductPropertyW(hProduct, szProperty, lpValueBuf, pcchValueBuf)

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

出力引数:

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