ホーム › System.ApplicationInstallationAndServicing › MsiGetPropertyW

MsiGetPropertyW

関数

実行中のインストールセッションのプロパティ値を取得する。

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

シグネチャ

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

DWORD MsiGetPropertyW(
    MSIHANDLE hInstall,
    LPCWSTR szName,
    LPWSTR szValueBuf,   // optional
    DWORD* pcchValueBuf   // optional
);

パラメーター

名前	型	方向	説明
hInstall	MSIHANDLE	in	DLL カスタムアクションに提供される、または MsiOpenPackage、MsiOpenPackageEx、MsiOpenProduct によって取得されるインストールへのハンドルです。
szName	LPCWSTR	in	プロパティ名を指定する null 終端文字列です。
szValueBuf	LPWSTR	outoptional	プロパティの値を格納する null 終端文字列を受け取るバッファーへのポインターです。szValueBuf に null (value=0) を渡してバッファーのサイズを判定しようとしないでください。バッファーのサイズを取得するには、空文字列(例: "")を渡します。その場合、関数は ERROR_MORE_DATA を返し、pchValueBuf に必要なバッファーサイズが TCHAR 単位(終端の null 文字を含まない)で格納されます。ERROR_SUCCESS が返された場合、pcchValueBuf にはバッファーに書き込まれた TCHAR 数(終端の null 文字を含まない)が格納されます。
pcchValueBuf	DWORD*	inoutoptional	変数 szValueBuf が指すバッファーのサイズを TCHAR 単位で指定する変数へのポインターです。関数が ERROR_SUCCESS を返すと、この変数には szValueBuf へコピーされたデータのサイズ(終端の null 文字を含まない)が格納されます。szValueBuf が十分な大きさでない場合、関数は ERROR_MORE_DATA を返し、必要なサイズ(終端の null 文字を含まない)を pchValueBuf が指す変数に格納します。

戻り値の型: DWORD

公式ドキュメント

MsiGetProperty 関数は、インストーラープロパティの値を取得します。(Unicode)

戻り値

この関数は UINT を返します。

解説(Remarks)

MsiGetProperty 関数で取得するプロパティの値が定義されていない場合、長さ 0 の値と同等に扱われます。これはエラーではありません。

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

次の例は、DLL カスタムアクションが値バッファーのサイズを動的に判定してプロパティの値にアクセスする方法を示しています。

UINT __stdcall MyCustomAction(MSIHANDLE hInstall)
{
    TCHAR* szValueBuf = NULL;
    DWORD cchValueBuf = 0;
    UINT uiStat =  MsiGetProperty(hInstall, TEXT("MyProperty"), TEXT(""), &cchValueBuf);
    //cchValueBuf now contains the size of the property's string, without null termination
    if (ERROR_MORE_DATA == uiStat)
    {
        ++cchValueBuf; // add 1 for null termination
        szValueBuf = new TCHAR[cchValueBuf];
        if (szValueBuf)
        {
            uiStat = MsiGetProperty(hInstall, TEXT("MyProperty"), szValueBuf, &cchValueBuf);
        }
    }
    if (ERROR_SUCCESS != uiStat)
    {
        if (szValueBuf != NULL) 
           delete[] szValueBuf;
        return ERROR_INSTALL_FAILURE;
    }

    // custom action uses MyProperty
    // ...

    delete[] szValueBuf;

    return ERROR_SUCCESS;
}

メモ

msiquery.h ヘッダーは MsiGetProperty を、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 MsiGetPropertyW(
    MSIHANDLE hInstall,
    LPCWSTR szName,
    LPWSTR szValueBuf,   // optional
    DWORD* pcchValueBuf   // optional
);

[DllImport("msi.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint MsiGetPropertyW(
    uint hInstall,   // MSIHANDLE
    [MarshalAs(UnmanagedType.LPWStr)] string szName,   // LPCWSTR
    [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 MsiGetPropertyW(
    hInstall As UInteger,   ' MSIHANDLE
    <MarshalAs(UnmanagedType.LPWStr)> szName As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> szValueBuf As System.Text.StringBuilder,   ' LPWSTR optional, out
    pcchValueBuf As IntPtr   ' DWORD* optional, in/out
) As UInteger
End Function

' hInstall : MSIHANDLE
' szName : LPCWSTR
' szValueBuf : LPWSTR optional, out
' pcchValueBuf : DWORD* optional, in/out
Declare PtrSafe Function MsiGetPropertyW Lib "msi" ( _
    ByVal hInstall As Long, _
    ByVal szName 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

MsiGetPropertyW = ctypes.windll.msi.MsiGetPropertyW
MsiGetPropertyW.restype = wintypes.DWORD
MsiGetPropertyW.argtypes = [
    wintypes.DWORD,  # hInstall : MSIHANDLE
    wintypes.LPCWSTR,  # szName : LPCWSTR
    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')
MsiGetPropertyW = Fiddle::Function.new(
  lib['MsiGetPropertyW'],
  [
    -Fiddle::TYPE_INT,  # hInstall : MSIHANDLE
    Fiddle::TYPE_VOIDP,  # szName : LPCWSTR
    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 MsiGetPropertyW(
        hInstall: u32,  // MSIHANDLE
        szName: *const u16,  // LPCWSTR
        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 MsiGetPropertyW(uint hInstall, [MarshalAs(UnmanagedType.LPWStr)] string szName, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder szValueBuf, IntPtr pcchValueBuf);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiGetPropertyW' -Namespace Win32 -PassThru
# $api::MsiGetPropertyW(hInstall, szName, szValueBuf, pcchValueBuf)

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

出力引数:

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