ホーム › System.ApplicationInstallationAndServicing › MsiEnumComponentQualifiersA

MsiEnumComponentQualifiersA

関数

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

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

シグネチャ

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

DWORD MsiEnumComponentQualifiersA(
    LPCSTR szComponent,
    DWORD iIndex,
    LPSTR lpQualifierBuf,
    DWORD* pcchQualifierBuf,
    LPSTR lpApplicationDataBuf,   // optional
    DWORD* pcchApplicationDataBuf   // optional
);

パラメーター

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

戻り値の型: DWORD

公式ドキュメント

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

戻り値

値	意味
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 パラメーターを 0 に設定して MsiEnumComponentQualifiers 関数を呼び出します。その後、アプリケーションは iIndex パラメーターをインクリメントしながら、修飾子がなくなるまで(つまり関数が ERROR_NO_MORE_ITEMS を返すまで) MsiEnumComponentQualifiers を呼び出します。

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

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

メモ

msi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして MsiEnumComponentQualifiers を定義します。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、コンパイルエラーや実行時エラーを引き起こす不整合が生じる可能性があります。詳細については、「関数プロトタイプの規則」を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 MsiEnumComponentQualifiersA(
    LPCSTR szComponent,
    DWORD iIndex,
    LPSTR lpQualifierBuf,
    DWORD* pcchQualifierBuf,
    LPSTR lpApplicationDataBuf,   // optional
    DWORD* pcchApplicationDataBuf   // optional
);

[DllImport("msi.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint MsiEnumComponentQualifiersA(
    [MarshalAs(UnmanagedType.LPStr)] string szComponent,   // LPCSTR
    uint iIndex,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpQualifierBuf,   // LPSTR out
    ref uint pcchQualifierBuf,   // DWORD* in/out
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpApplicationDataBuf,   // LPSTR optional, out
    IntPtr pcchApplicationDataBuf   // DWORD* optional, in/out
);

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

' szComponent : LPCSTR
' iIndex : DWORD
' lpQualifierBuf : LPSTR out
' pcchQualifierBuf : DWORD* in/out
' lpApplicationDataBuf : LPSTR optional, out
' pcchApplicationDataBuf : DWORD* optional, in/out
Declare PtrSafe Function MsiEnumComponentQualifiersA Lib "msi" ( _
    ByVal szComponent As String, _
    ByVal iIndex As Long, _
    ByVal lpQualifierBuf As String, _
    ByRef pcchQualifierBuf As Long, _
    ByVal lpApplicationDataBuf As String, _
    ByVal pcchApplicationDataBuf As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

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

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiEnumComponentQualifiersA = Fiddle::Function.new(
  lib['MsiEnumComponentQualifiersA'],
  [
    Fiddle::TYPE_VOIDP,  # szComponent : LPCSTR
    -Fiddle::TYPE_INT,  # iIndex : DWORD
    Fiddle::TYPE_VOIDP,  # lpQualifierBuf : LPSTR out
    Fiddle::TYPE_VOIDP,  # pcchQualifierBuf : DWORD* in/out
    Fiddle::TYPE_VOIDP,  # lpApplicationDataBuf : LPSTR optional, out
    Fiddle::TYPE_VOIDP,  # pcchApplicationDataBuf : DWORD* optional, in/out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "msi")]
extern "system" {
    fn MsiEnumComponentQualifiersA(
        szComponent: *const u8,  // LPCSTR
        iIndex: u32,  // DWORD
        lpQualifierBuf: *mut u8,  // LPSTR out
        pcchQualifierBuf: *mut u32,  // DWORD* in/out
        lpApplicationDataBuf: *mut u8,  // LPSTR 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.Ansi)]
public static extern uint MsiEnumComponentQualifiersA([MarshalAs(UnmanagedType.LPStr)] string szComponent, uint iIndex, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpQualifierBuf, ref uint pcchQualifierBuf, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpApplicationDataBuf, IntPtr pcchApplicationDataBuf);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiEnumComponentQualifiersA' -Namespace Win32 -PassThru
# $api::MsiEnumComponentQualifiersA(szComponent, iIndex, lpQualifierBuf, pcchQualifierBuf, lpApplicationDataBuf, pcchApplicationDataBuf)

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

出力引数:

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