ホーム › System.ApplicationInstallationAndServicing › MsiEnumComponentQualifiersW

MsiEnumComponentQualifiersW

関数

指定コンポーネントの修飾子とアプリケーションデータを列挙する。

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

シグネチャ

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

DWORD MsiEnumComponentQualifiersW(
    LPCWSTR szComponent,
    DWORD iIndex,
    LPWSTR lpQualifierBuf,
    DWORD* pcchQualifierBuf,
    LPWSTR lpApplicationDataBuf,   // optional
    DWORD* pcchApplicationDataBuf   // optional
);

パラメーター

名前	型	方向	説明
szComponent	LPCWSTR	in	修飾子を列挙する対象のコンポーネントを指定します。
iIndex	DWORD	in	取得する修飾子のインデックスを指定します。このパラメーターは、 MsiEnumComponentQualifiers 関数の最初の呼び出しではゼロにし、その後の呼び出しごとに増分する必要があります。修飾子には順序が付けられていないため、新しい修飾子は任意のインデックスを持ちます。つまり、この関数は修飾子を任意の順序で返す可能性があります。
lpQualifierBuf	LPWSTR	out	修飾子コードを受け取るバッファーへのポインター。
pcchQualifierBuf	DWORD*	inout	lpQualifierBuf パラメーターが指すバッファーのサイズ (文字数単位) を指定する変数へのポインター。入力時には、このサイズに終端の null 文字を含める必要があります。戻り時には、その値に null 文字は含まれません。
lpApplicationDataBuf	LPWSTR	outoptional	修飾子に登録されたアプリケーションデータを受け取るバッファーへのポインター。このパラメーターは null にできます。
pcchApplicationDataBuf	DWORD*	inoutoptional	lpApplicationDataBuf パラメーターが指すバッファーのサイズ (文字数単位) を指定する変数へのポインター。入力時には、このサイズに終端の null 文字を含める必要があります。戻り時には、その値に null 文字は含まれません。このパラメーターを null にできるのは、lpApplicationDataBuf パラメーターが null の場合に限ります。

戻り値の型: DWORD

公式ドキュメント

MsiEnumComponentQualifiers 関数は、指定されたコンポーネントについて、アドバタイズされた修飾子 (qualifier) を列挙します。この関数は、呼び出されるたびに 1 つの修飾子を取得します。(Unicode)

戻り値

値	意味
ERROR_BAD_CONFIGURATION	構成データが破損しています。
ERROR_INVALID_PARAMETER	無効なパラメーターが関数に渡されました。
ERROR_MORE_DATA	バッファーが小さすぎて、要求されたデータを格納できません。
ERROR_NO_MORE_ITEMS	返すべき修飾子がありません。
ERROR_NOT_ENOUGH_MEMORY	この操作を完了するのに十分なメモリがシステムにありません。Windows Server 2003 以降で使用できます。
ERROR_SUCCESS	値が列挙されました。
ERROR_UNKNOWN_COMPONENT	指定されたコンポーネントは不明です。

解説(Remarks)

修飾子を列挙するには、アプリケーションは最初に iIndex パラメーターをゼロに設定して MsiEnumComponentQualifiers 関数を呼び出す必要があります。その後、アプリケーションは iIndex パラメーターを増分し、修飾子がなくなるまで (つまり、関数が ERROR_NO_MORE_ITEMS を返すまで) MsiEnumComponentQualifiers を呼び出します。

MsiEnumComponentQualifiers が返ると、pcchQualifierBuf パラメーターには、バッファーに格納された修飾子文字列の長さが入ります。返されるカウントには終端の null 文字は含まれません。バッファーが十分な大きさでない場合、 MsiEnumComponentQualifiers は ERROR_MORE_DATA を返し、このパラメーターには文字列のサイズ (文字数単位、null 文字を除く) が入ります。同じ仕組みが pcchDescriptionBuf にも適用されます。

コンポーネントのアドバタイズされた修飾子をすべて列挙するために MsiEnumComponentQualifiers を複数回呼び出す場合、各呼び出しは同じスレッドから行う必要があります。

メモ

msi.h ヘッダーは MsiEnumComponentQualifiers をエイリアスとして定義しており、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 MsiEnumComponentQualifiersW(
    LPCWSTR szComponent,
    DWORD iIndex,
    LPWSTR lpQualifierBuf,
    DWORD* pcchQualifierBuf,
    LPWSTR lpApplicationDataBuf,   // optional
    DWORD* pcchApplicationDataBuf   // optional
);

[DllImport("msi.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint MsiEnumComponentQualifiersW(
    [MarshalAs(UnmanagedType.LPWStr)] string szComponent,   // LPCWSTR
    uint iIndex,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpQualifierBuf,   // LPWSTR out
    ref uint pcchQualifierBuf,   // DWORD* in/out
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpApplicationDataBuf,   // LPWSTR optional, out
    IntPtr pcchApplicationDataBuf   // DWORD* optional, in/out
);

<DllImport("msi.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function MsiEnumComponentQualifiersW(
    <MarshalAs(UnmanagedType.LPWStr)> szComponent As String,   ' LPCWSTR
    iIndex As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> lpQualifierBuf As System.Text.StringBuilder,   ' LPWSTR out
    ByRef pcchQualifierBuf As UInteger,   ' DWORD* in/out
    <MarshalAs(UnmanagedType.LPWStr)> lpApplicationDataBuf As System.Text.StringBuilder,   ' LPWSTR optional, out
    pcchApplicationDataBuf As IntPtr   ' DWORD* optional, in/out
) As UInteger
End Function

' szComponent : LPCWSTR
' iIndex : DWORD
' lpQualifierBuf : LPWSTR out
' pcchQualifierBuf : DWORD* in/out
' lpApplicationDataBuf : LPWSTR optional, out
' pcchApplicationDataBuf : DWORD* optional, in/out
Declare PtrSafe Function MsiEnumComponentQualifiersW Lib "msi" ( _
    ByVal szComponent As LongPtr, _
    ByVal iIndex As Long, _
    ByVal lpQualifierBuf As LongPtr, _
    ByRef pcchQualifierBuf As Long, _
    ByVal lpApplicationDataBuf As LongPtr, _
    ByVal pcchApplicationDataBuf 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

MsiEnumComponentQualifiersW = ctypes.windll.msi.MsiEnumComponentQualifiersW
MsiEnumComponentQualifiersW.restype = wintypes.DWORD
MsiEnumComponentQualifiersW.argtypes = [
    wintypes.LPCWSTR,  # szComponent : LPCWSTR
    wintypes.DWORD,  # iIndex : DWORD
    wintypes.LPWSTR,  # lpQualifierBuf : LPWSTR out
    ctypes.POINTER(wintypes.DWORD),  # pcchQualifierBuf : DWORD* in/out
    wintypes.LPWSTR,  # lpApplicationDataBuf : LPWSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcchApplicationDataBuf : DWORD* optional, in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiEnumComponentQualifiersW = Fiddle::Function.new(
  lib['MsiEnumComponentQualifiersW'],
  [
    Fiddle::TYPE_VOIDP,  # szComponent : LPCWSTR
    -Fiddle::TYPE_INT,  # iIndex : DWORD
    Fiddle::TYPE_VOIDP,  # lpQualifierBuf : LPWSTR out
    Fiddle::TYPE_VOIDP,  # pcchQualifierBuf : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # lpApplicationDataBuf : LPWSTR optional, out
    Fiddle::TYPE_VOIDP,  # pcchApplicationDataBuf : DWORD* optional, in/out
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "msi")]
extern "system" {
    fn MsiEnumComponentQualifiersW(
        szComponent: *const u16,  // LPCWSTR
        iIndex: u32,  // DWORD
        lpQualifierBuf: *mut u16,  // LPWSTR out
        pcchQualifierBuf: *mut u32,  // DWORD* in/out
        lpApplicationDataBuf: *mut u16,  // LPWSTR optional, out
        pcchApplicationDataBuf: *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 MsiEnumComponentQualifiersW([MarshalAs(UnmanagedType.LPWStr)] string szComponent, uint iIndex, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpQualifierBuf, ref uint pcchQualifierBuf, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpApplicationDataBuf, IntPtr pcchApplicationDataBuf);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiEnumComponentQualifiersW' -Namespace Win32 -PassThru
# $api::MsiEnumComponentQualifiersW(szComponent, iIndex, lpQualifierBuf, pcchQualifierBuf, lpApplicationDataBuf, pcchApplicationDataBuf)

#uselib "msi.dll"
#func global MsiEnumComponentQualifiersW "MsiEnumComponentQualifiersW" wptr, wptr, wptr, wptr, wptr, wptr
; MsiEnumComponentQualifiersW szComponent, iIndex, varptr(lpQualifierBuf), varptr(pcchQualifierBuf), varptr(lpApplicationDataBuf), varptr(pcchApplicationDataBuf)   ; 戻り値は stat
; szComponent : LPCWSTR -> "wptr"
; iIndex : DWORD -> "wptr"
; lpQualifierBuf : LPWSTR out -> "wptr"
; pcchQualifierBuf : DWORD* in/out -> "wptr"
; lpApplicationDataBuf : LPWSTR optional, out -> "wptr"
; pcchApplicationDataBuf : DWORD* optional, in/out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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