ホーム › System.ApplicationInstallationAndServicing › MsiEnumClientsExW

MsiEnumClientsExW

関数

コンテキストやユーザーを指定してコンポーネントのクライアント製品を列挙する。

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

シグネチャ

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

DWORD MsiEnumClientsExW(
    LPCWSTR szComponent,
    LPCWSTR szUserSid,   // optional
    DWORD dwContext,
    DWORD dwProductIndex,
    LPWSTR szProductBuf,   // optional
    MSIINSTALLCONTEXT* pdwInstalledContext,   // optional
    LPWSTR szSid,   // optional
    DWORD* pcchSid   // optional
);

パラメーター

名前	型	方向
szComponent	LPCWSTR	in
szUserSid	LPCWSTR	inoptional
dwContext	DWORD	in
dwProductIndex	DWORD	in
szProductBuf	LPWSTR	outoptional
pdwInstalledContext	MSIINSTALLCONTEXT*	outoptional
szSid	LPWSTR	outoptional
pcchSid	DWORD*	inoutoptional

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD MsiEnumClientsExW(
    LPCWSTR szComponent,
    LPCWSTR szUserSid,   // optional
    DWORD dwContext,
    DWORD dwProductIndex,
    LPWSTR szProductBuf,   // optional
    MSIINSTALLCONTEXT* pdwInstalledContext,   // optional
    LPWSTR szSid,   // optional
    DWORD* pcchSid   // optional
);

[DllImport("msi.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint MsiEnumClientsExW(
    [MarshalAs(UnmanagedType.LPWStr)] string szComponent,   // LPCWSTR
    [MarshalAs(UnmanagedType.LPWStr)] string szUserSid,   // LPCWSTR optional
    uint dwContext,   // DWORD
    uint dwProductIndex,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder szProductBuf,   // 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 MsiEnumClientsExW(
    <MarshalAs(UnmanagedType.LPWStr)> szComponent As String,   ' LPCWSTR
    <MarshalAs(UnmanagedType.LPWStr)> szUserSid As String,   ' LPCWSTR optional
    dwContext As UInteger,   ' DWORD
    dwProductIndex As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> szProductBuf 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

' szComponent : LPCWSTR
' szUserSid : LPCWSTR optional
' dwContext : DWORD
' dwProductIndex : DWORD
' szProductBuf : LPWSTR optional, out
' pdwInstalledContext : MSIINSTALLCONTEXT* optional, out
' szSid : LPWSTR optional, out
' pcchSid : DWORD* optional, in/out
Declare PtrSafe Function MsiEnumClientsExW Lib "msi" ( _
    ByVal szComponent As LongPtr, _
    ByVal szUserSid As LongPtr, _
    ByVal dwContext As Long, _
    ByVal dwProductIndex As Long, _
    ByVal szProductBuf 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

MsiEnumClientsExW = ctypes.windll.msi.MsiEnumClientsExW
MsiEnumClientsExW.restype = wintypes.DWORD
MsiEnumClientsExW.argtypes = [
    wintypes.LPCWSTR,  # szComponent : LPCWSTR
    wintypes.LPCWSTR,  # szUserSid : LPCWSTR optional
    wintypes.DWORD,  # dwContext : DWORD
    wintypes.DWORD,  # dwProductIndex : DWORD
    wintypes.LPWSTR,  # szProductBuf : 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')
MsiEnumClientsExW = Fiddle::Function.new(
  lib['MsiEnumClientsExW'],
  [
    Fiddle::TYPE_VOIDP,  # szComponent : LPCWSTR
    Fiddle::TYPE_VOIDP,  # szUserSid : LPCWSTR optional
    -Fiddle::TYPE_INT,  # dwContext : DWORD
    -Fiddle::TYPE_INT,  # dwProductIndex : DWORD
    Fiddle::TYPE_VOIDP,  # szProductBuf : 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 MsiEnumClientsExW(
        szComponent: *const u16,  // LPCWSTR
        szUserSid: *const u16,  // LPCWSTR optional
        dwContext: u32,  // DWORD
        dwProductIndex: u32,  // DWORD
        szProductBuf: *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 MsiEnumClientsExW([MarshalAs(UnmanagedType.LPWStr)] string szComponent, [MarshalAs(UnmanagedType.LPWStr)] string szUserSid, uint dwContext, uint dwProductIndex, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder szProductBuf, IntPtr pdwInstalledContext, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder szSid, IntPtr pcchSid);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiEnumClientsExW' -Namespace Win32 -PassThru
# $api::MsiEnumClientsExW(szComponent, szUserSid, dwContext, dwProductIndex, szProductBuf, pdwInstalledContext, szSid, pcchSid)

#uselib "msi.dll"
#func global MsiEnumClientsExW "MsiEnumClientsExW" wptr, wptr, wptr, wptr, wptr, wptr, wptr, wptr
; MsiEnumClientsExW szComponent, szUserSid, dwContext, dwProductIndex, varptr(szProductBuf), pdwInstalledContext, varptr(szSid), varptr(pcchSid)   ; 戻り値は stat
; szComponent : LPCWSTR -> "wptr"
; szUserSid : LPCWSTR optional -> "wptr"
; dwContext : DWORD -> "wptr"
; dwProductIndex : DWORD -> "wptr"
; szProductBuf : 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 MsiEnumClientsExW "MsiEnumClientsExW" wstr, wstr, int, int, var, int, var, var
; res = MsiEnumClientsExW(szComponent, szUserSid, dwContext, dwProductIndex, szProductBuf, pdwInstalledContext, szSid, pcchSid)
; szComponent : LPCWSTR -> "wstr"
; szUserSid : LPCWSTR optional -> "wstr"
; dwContext : DWORD -> "int"
; dwProductIndex : DWORD -> "int"
; szProductBuf : LPWSTR optional, out -> "var"
; pdwInstalledContext : MSIINSTALLCONTEXT* optional, out -> "int"
; szSid : LPWSTR optional, out -> "var"
; pcchSid : DWORD* optional, in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "msi.dll"
#cfunc global MsiEnumClientsExW "MsiEnumClientsExW" wstr, wstr, int, int, sptr, int, sptr, sptr
; res = MsiEnumClientsExW(szComponent, szUserSid, dwContext, dwProductIndex, varptr(szProductBuf), pdwInstalledContext, varptr(szSid), varptr(pcchSid))
; szComponent : LPCWSTR -> "wstr"
; szUserSid : LPCWSTR optional -> "wstr"
; dwContext : DWORD -> "int"
; dwProductIndex : DWORD -> "int"
; szProductBuf : LPWSTR optional, out -> "sptr"
; pdwInstalledContext : MSIINSTALLCONTEXT* optional, out -> "int"
; szSid : LPWSTR optional, out -> "sptr"
; pcchSid : DWORD* optional, in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。

出力引数:

; DWORD MsiEnumClientsExW(LPCWSTR szComponent, LPCWSTR szUserSid, DWORD dwContext, DWORD dwProductIndex, LPWSTR szProductBuf, MSIINSTALLCONTEXT* pdwInstalledContext, LPWSTR szSid, DWORD* pcchSid)
#uselib "msi.dll"
#cfunc global MsiEnumClientsExW "MsiEnumClientsExW" wstr, wstr, int, int, var, int, var, var
; res = MsiEnumClientsExW(szComponent, szUserSid, dwContext, dwProductIndex, szProductBuf, pdwInstalledContext, szSid, pcchSid)
; szComponent : LPCWSTR -> "wstr"
; szUserSid : LPCWSTR optional -> "wstr"
; dwContext : DWORD -> "int"
; dwProductIndex : DWORD -> "int"
; szProductBuf : LPWSTR optional, out -> "var"
; pdwInstalledContext : MSIINSTALLCONTEXT* optional, out -> "int"
; szSid : LPWSTR optional, out -> "var"
; pcchSid : DWORD* optional, in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; DWORD MsiEnumClientsExW(LPCWSTR szComponent, LPCWSTR szUserSid, DWORD dwContext, DWORD dwProductIndex, LPWSTR szProductBuf, MSIINSTALLCONTEXT* pdwInstalledContext, LPWSTR szSid, DWORD* pcchSid)
#uselib "msi.dll"
#cfunc global MsiEnumClientsExW "MsiEnumClientsExW" wstr, wstr, int, int, intptr, int, intptr, intptr
; res = MsiEnumClientsExW(szComponent, szUserSid, dwContext, dwProductIndex, varptr(szProductBuf), pdwInstalledContext, varptr(szSid), varptr(pcchSid))
; szComponent : LPCWSTR -> "wstr"
; szUserSid : LPCWSTR optional -> "wstr"
; dwContext : DWORD -> "int"
; dwProductIndex : DWORD -> "int"
; szProductBuf : LPWSTR optional, out -> "intptr"
; pdwInstalledContext : MSIINSTALLCONTEXT* optional, out -> "int"
; szSid : LPWSTR optional, out -> "intptr"
; pcchSid : DWORD* optional, in/out -> "intptr"
; ※出力/バッファ引数はポインタ方式(token=intptr / 呼び出しは varptr(変数))。

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	msi = windows.NewLazySystemDLL("msi.dll")
	procMsiEnumClientsExW = msi.NewProc("MsiEnumClientsExW")
)

// szComponent (LPCWSTR), szUserSid (LPCWSTR optional), dwContext (DWORD), dwProductIndex (DWORD), szProductBuf (LPWSTR optional, out), pdwInstalledContext (MSIINSTALLCONTEXT* optional, out), szSid (LPWSTR optional, out), pcchSid (DWORD* optional, in/out)
r1, _, err := procMsiEnumClientsExW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(szComponent))),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(szUserSid))),
	uintptr(dwContext),
	uintptr(dwProductIndex),
	uintptr(szProductBuf),
	uintptr(pdwInstalledContext),
	uintptr(szSid),
	uintptr(pcchSid),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD

function MsiEnumClientsExW(
  szComponent: PWideChar;   // LPCWSTR
  szUserSid: PWideChar;   // LPCWSTR optional
  dwContext: DWORD;   // DWORD
  dwProductIndex: DWORD;   // DWORD
  szProductBuf: 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 'MsiEnumClientsExW';

result := DllCall("msi\MsiEnumClientsExW"
    , "WStr", szComponent   ; LPCWSTR
    , "WStr", szUserSid   ; LPCWSTR optional
    , "UInt", dwContext   ; DWORD
    , "UInt", dwProductIndex   ; DWORD
    , "Ptr", szProductBuf   ; LPWSTR optional, out
    , "Ptr", pdwInstalledContext   ; MSIINSTALLCONTEXT* optional, out
    , "Ptr", szSid   ; LPWSTR optional, out
    , "Ptr", pcchSid   ; DWORD* optional, in/out
    , "UInt")   ; return: DWORD

●MsiEnumClientsExW(szComponent, szUserSid, dwContext, dwProductIndex, szProductBuf, pdwInstalledContext, szSid, pcchSid) = DLL("msi.dll", "dword MsiEnumClientsExW(char*, char*, dword, dword, char*, void*, char*, void*)")
# 呼び出し: MsiEnumClientsExW(szComponent, szUserSid, dwContext, dwProductIndex, szProductBuf, pdwInstalledContext, szSid, pcchSid)
# szComponent : LPCWSTR -> "char*"
# szUserSid : LPCWSTR optional -> "char*"
# dwContext : DWORD -> "dword"
# dwProductIndex : DWORD -> "dword"
# szProductBuf : 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 版の利用を推奨。