Win32 API 日本語リファレンス
ホームSystem.ApplicationInstallationAndServicing › MsiEnumComponentsExW

MsiEnumComponentsExW

関数
コンテキストやユーザーを指定して登録済みコンポーネントを列挙する。
DLLmsi.dll文字セットUnicode (-W)呼出規約winapi対応OSwindows8.0

シグネチャ

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

DWORD MsiEnumComponentsExW(
    LPCWSTR szUserSid,   // optional
    DWORD dwContext,
    DWORD dwIndex,
    LPWSTR szInstalledComponentCode,   // optional
    MSIINSTALLCONTEXT* pdwInstalledContext,   // optional
    LPWSTR szSid,   // optional
    DWORD* pcchSid   // optional
);

パラメーター

名前方向
szUserSidLPCWSTRinoptional
dwContextDWORDin
dwIndexDWORDin
szInstalledComponentCodeLPWSTRoutoptional
pdwInstalledContextMSIINSTALLCONTEXT*outoptional
szSidLPWSTRoutoptional
pcchSidDWORD*inoutoptional

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD MsiEnumComponentsExW(
    LPCWSTR szUserSid,   // optional
    DWORD dwContext,
    DWORD dwIndex,
    LPWSTR szInstalledComponentCode,   // optional
    MSIINSTALLCONTEXT* pdwInstalledContext,   // optional
    LPWSTR szSid,   // optional
    DWORD* pcchSid   // optional
);
[DllImport("msi.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint MsiEnumComponentsExW(
    [MarshalAs(UnmanagedType.LPWStr)] string szUserSid,   // LPCWSTR optional
    uint dwContext,   // DWORD
    uint dwIndex,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder szInstalledComponentCode,   // LPWSTR optional, out
    IntPtr pdwInstalledContext,   // MSIINSTALLCONTEXT* optional, out
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder szSid,   // LPWSTR optional, out
    IntPtr pcchSid   // DWORD* optional, in/out
);
<DllImport("msi.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function MsiEnumComponentsExW(
    <MarshalAs(UnmanagedType.LPWStr)> szUserSid As String,   ' LPCWSTR optional
    dwContext As UInteger,   ' DWORD
    dwIndex As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> szInstalledComponentCode As System.Text.StringBuilder,   ' LPWSTR optional, out
    pdwInstalledContext As IntPtr,   ' MSIINSTALLCONTEXT* optional, out
    <MarshalAs(UnmanagedType.LPWStr)> szSid As System.Text.StringBuilder,   ' LPWSTR optional, out
    pcchSid As IntPtr   ' DWORD* optional, in/out
) As UInteger
End Function
' szUserSid : LPCWSTR optional
' dwContext : DWORD
' dwIndex : DWORD
' szInstalledComponentCode : LPWSTR optional, out
' pdwInstalledContext : MSIINSTALLCONTEXT* optional, out
' szSid : LPWSTR optional, out
' pcchSid : DWORD* optional, in/out
Declare PtrSafe Function MsiEnumComponentsExW Lib "msi" ( _
    ByVal szUserSid As LongPtr, _
    ByVal dwContext As Long, _
    ByVal dwIndex As Long, _
    ByVal szInstalledComponentCode As LongPtr, _
    ByVal pdwInstalledContext As LongPtr, _
    ByVal szSid As LongPtr, _
    ByVal pcchSid 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

MsiEnumComponentsExW = ctypes.windll.msi.MsiEnumComponentsExW
MsiEnumComponentsExW.restype = wintypes.DWORD
MsiEnumComponentsExW.argtypes = [
    wintypes.LPCWSTR,  # szUserSid : LPCWSTR optional
    wintypes.DWORD,  # dwContext : DWORD
    wintypes.DWORD,  # dwIndex : DWORD
    wintypes.LPWSTR,  # szInstalledComponentCode : LPWSTR optional, out
    ctypes.c_void_p,  # pdwInstalledContext : MSIINSTALLCONTEXT* optional, out
    wintypes.LPWSTR,  # szSid : LPWSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcchSid : DWORD* optional, in/out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiEnumComponentsExW = Fiddle::Function.new(
  lib['MsiEnumComponentsExW'],
  [
    Fiddle::TYPE_VOIDP,  # szUserSid : LPCWSTR optional
    -Fiddle::TYPE_INT,  # dwContext : DWORD
    -Fiddle::TYPE_INT,  # dwIndex : DWORD
    Fiddle::TYPE_VOIDP,  # szInstalledComponentCode : LPWSTR optional, out
    Fiddle::TYPE_VOIDP,  # pdwInstalledContext : MSIINSTALLCONTEXT* optional, out
    Fiddle::TYPE_VOIDP,  # szSid : LPWSTR optional, out
    Fiddle::TYPE_VOIDP,  # pcchSid : DWORD* optional, in/out
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "msi")]
extern "system" {
    fn MsiEnumComponentsExW(
        szUserSid: *const u16,  // LPCWSTR optional
        dwContext: u32,  // DWORD
        dwIndex: u32,  // DWORD
        szInstalledComponentCode: *mut u16,  // LPWSTR optional, out
        pdwInstalledContext: *mut i32,  // MSIINSTALLCONTEXT* optional, out
        szSid: *mut u16,  // LPWSTR optional, out
        pcchSid: *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 MsiEnumComponentsExW([MarshalAs(UnmanagedType.LPWStr)] string szUserSid, uint dwContext, uint dwIndex, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder szInstalledComponentCode, IntPtr pdwInstalledContext, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder szSid, IntPtr pcchSid);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiEnumComponentsExW' -Namespace Win32 -PassThru
# $api::MsiEnumComponentsExW(szUserSid, dwContext, dwIndex, szInstalledComponentCode, pdwInstalledContext, szSid, pcchSid)
#uselib "msi.dll"
#func global MsiEnumComponentsExW "MsiEnumComponentsExW" wptr, wptr, wptr, wptr, wptr, wptr, wptr
; MsiEnumComponentsExW szUserSid, dwContext, dwIndex, varptr(szInstalledComponentCode), pdwInstalledContext, varptr(szSid), varptr(pcchSid)   ; 戻り値は stat
; szUserSid : LPCWSTR optional -> "wptr"
; dwContext : DWORD -> "wptr"
; dwIndex : DWORD -> "wptr"
; szInstalledComponentCode : LPWSTR optional, out -> "wptr"
; pdwInstalledContext : MSIINSTALLCONTEXT* optional, out -> "wptr"
; szSid : LPWSTR optional, out -> "wptr"
; pcchSid : DWORD* optional, in/out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "msi.dll"
#cfunc global MsiEnumComponentsExW "MsiEnumComponentsExW" wstr, int, int, var, int, var, var
; res = MsiEnumComponentsExW(szUserSid, dwContext, dwIndex, szInstalledComponentCode, pdwInstalledContext, szSid, pcchSid)
; szUserSid : LPCWSTR optional -> "wstr"
; dwContext : DWORD -> "int"
; dwIndex : DWORD -> "int"
; szInstalledComponentCode : LPWSTR optional, out -> "var"
; pdwInstalledContext : MSIINSTALLCONTEXT* optional, out -> "int"
; szSid : LPWSTR optional, out -> "var"
; pcchSid : DWORD* optional, in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD MsiEnumComponentsExW(LPCWSTR szUserSid, DWORD dwContext, DWORD dwIndex, LPWSTR szInstalledComponentCode, MSIINSTALLCONTEXT* pdwInstalledContext, LPWSTR szSid, DWORD* pcchSid)
#uselib "msi.dll"
#cfunc global MsiEnumComponentsExW "MsiEnumComponentsExW" wstr, int, int, var, int, var, var
; res = MsiEnumComponentsExW(szUserSid, dwContext, dwIndex, szInstalledComponentCode, pdwInstalledContext, szSid, pcchSid)
; szUserSid : LPCWSTR optional -> "wstr"
; dwContext : DWORD -> "int"
; dwIndex : DWORD -> "int"
; szInstalledComponentCode : LPWSTR optional, out -> "var"
; pdwInstalledContext : MSIINSTALLCONTEXT* optional, out -> "int"
; szSid : LPWSTR optional, out -> "var"
; pcchSid : DWORD* optional, in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	msi = windows.NewLazySystemDLL("msi.dll")
	procMsiEnumComponentsExW = msi.NewProc("MsiEnumComponentsExW")
)

// szUserSid (LPCWSTR optional), dwContext (DWORD), dwIndex (DWORD), szInstalledComponentCode (LPWSTR optional, out), pdwInstalledContext (MSIINSTALLCONTEXT* optional, out), szSid (LPWSTR optional, out), pcchSid (DWORD* optional, in/out)
r1, _, err := procMsiEnumComponentsExW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(szUserSid))),
	uintptr(dwContext),
	uintptr(dwIndex),
	uintptr(szInstalledComponentCode),
	uintptr(pdwInstalledContext),
	uintptr(szSid),
	uintptr(pcchSid),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function MsiEnumComponentsExW(
  szUserSid: PWideChar;   // LPCWSTR optional
  dwContext: DWORD;   // DWORD
  dwIndex: DWORD;   // DWORD
  szInstalledComponentCode: PWideChar;   // LPWSTR optional, out
  pdwInstalledContext: Pointer;   // MSIINSTALLCONTEXT* optional, out
  szSid: PWideChar;   // LPWSTR optional, out
  pcchSid: Pointer   // DWORD* optional, in/out
): DWORD; stdcall;
  external 'msi.dll' name 'MsiEnumComponentsExW';
result := DllCall("msi\MsiEnumComponentsExW"
    , "WStr", szUserSid   ; LPCWSTR optional
    , "UInt", dwContext   ; DWORD
    , "UInt", dwIndex   ; DWORD
    , "Ptr", szInstalledComponentCode   ; LPWSTR optional, out
    , "Ptr", pdwInstalledContext   ; MSIINSTALLCONTEXT* optional, out
    , "Ptr", szSid   ; LPWSTR optional, out
    , "Ptr", pcchSid   ; DWORD* optional, in/out
    , "UInt")   ; return: DWORD
●MsiEnumComponentsExW(szUserSid, dwContext, dwIndex, szInstalledComponentCode, pdwInstalledContext, szSid, pcchSid) = DLL("msi.dll", "dword MsiEnumComponentsExW(char*, dword, dword, char*, void*, char*, void*)")
# 呼び出し: MsiEnumComponentsExW(szUserSid, dwContext, dwIndex, szInstalledComponentCode, pdwInstalledContext, szSid, pcchSid)
# szUserSid : LPCWSTR optional -> "char*"
# dwContext : DWORD -> "dword"
# dwIndex : DWORD -> "dword"
# szInstalledComponentCode : LPWSTR optional, out -> "char*"
# pdwInstalledContext : MSIINSTALLCONTEXT* optional, out -> "void*"
# szSid : LPWSTR optional, out -> "char*"
# pcchSid : DWORD* optional, in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。