ホーム › System.ApplicationInstallationAndServicing › MsiGetPropertyA

MsiGetPropertyA

関数

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

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

シグネチャ

// msi.dll  (ANSI / -A)
#include <windows.h>

DWORD MsiGetPropertyA(
    MSIHANDLE hInstall,
    LPCSTR szName,
    LPSTR szValueBuf,   // optional
    DWORD* pcchValueBuf   // optional
);

パラメーター

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

戻り値の型: DWORD

公式ドキュメント

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

戻り値

この関数は 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 版を自動的に選択するエイリアスとして定義します。エンコーディング非依存のエイリアスの使用を、エンコーディング非依存でないコードと混在させると、不一致が生じ、コンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、関数プロトタイプの規約を参照してください。

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

各言語での呼び出し定義

// msi.dll  (ANSI / -A)
#include <windows.h>

DWORD MsiGetPropertyA(
    MSIHANDLE hInstall,
    LPCSTR szName,
    LPSTR szValueBuf,   // optional
    DWORD* pcchValueBuf   // optional
);

[DllImport("msi.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint MsiGetPropertyA(
    uint hInstall,   // MSIHANDLE
    [MarshalAs(UnmanagedType.LPStr)] string szName,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder szValueBuf,   // LPSTR optional, out
    IntPtr pcchValueBuf   // DWORD* optional, in/out
);

<DllImport("msi.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function MsiGetPropertyA(
    hInstall As UInteger,   ' MSIHANDLE
    <MarshalAs(UnmanagedType.LPStr)> szName As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> szValueBuf As System.Text.StringBuilder,   ' LPSTR optional, out
    pcchValueBuf As IntPtr   ' DWORD* optional, in/out
) As UInteger
End Function

' hInstall : MSIHANDLE
' szName : LPCSTR
' szValueBuf : LPSTR optional, out
' pcchValueBuf : DWORD* optional, in/out
Declare PtrSafe Function MsiGetPropertyA Lib "msi" ( _
    ByVal hInstall As Long, _
    ByVal szName As String, _
    ByVal szValueBuf As String, _
    ByVal pcchValueBuf As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

MsiGetPropertyA = ctypes.windll.msi.MsiGetPropertyA
MsiGetPropertyA.restype = wintypes.DWORD
MsiGetPropertyA.argtypes = [
    wintypes.DWORD,  # hInstall : MSIHANDLE
    wintypes.LPCSTR,  # szName : LPCSTR
    wintypes.LPSTR,  # szValueBuf : LPSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcchValueBuf : DWORD* optional, in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiGetPropertyA = Fiddle::Function.new(
  lib['MsiGetPropertyA'],
  [
    -Fiddle::TYPE_INT,  # hInstall : MSIHANDLE
    Fiddle::TYPE_VOIDP,  # szName : LPCSTR
    Fiddle::TYPE_VOIDP,  # szValueBuf : LPSTR optional, out
    Fiddle::TYPE_VOIDP,  # pcchValueBuf : DWORD* optional, in/out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "msi")]
extern "system" {
    fn MsiGetPropertyA(
        hInstall: u32,  // MSIHANDLE
        szName: *const u8,  // LPCSTR
        szValueBuf: *mut u8,  // LPSTR 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.Ansi)]
public static extern uint MsiGetPropertyA(uint hInstall, [MarshalAs(UnmanagedType.LPStr)] string szName, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder szValueBuf, IntPtr pcchValueBuf);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiGetPropertyA' -Namespace Win32 -PassThru
# $api::MsiGetPropertyA(hInstall, szName, szValueBuf, pcchValueBuf)

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

出力引数:

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