ホーム › System.ApplicationInstallationAndServicing › MsiEnumClientsExA

MsiEnumClientsExA

関数

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

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

シグネチャ

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

DWORD MsiEnumClientsExA(
    LPCSTR szComponent,
    LPCSTR szUserSid,   // optional
    DWORD dwContext,
    DWORD dwProductIndex,
    LPSTR szProductBuf,   // optional
    MSIINSTALLCONTEXT* pdwInstalledContext,   // optional
    LPSTR szSid,   // optional
    DWORD* pcchSid   // optional
);

パラメーター

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

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD MsiEnumClientsExA(
    LPCSTR szComponent,
    LPCSTR szUserSid,   // optional
    DWORD dwContext,
    DWORD dwProductIndex,
    LPSTR szProductBuf,   // optional
    MSIINSTALLCONTEXT* pdwInstalledContext,   // optional
    LPSTR szSid,   // optional
    DWORD* pcchSid   // optional
);

[DllImport("msi.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint MsiEnumClientsExA(
    [MarshalAs(UnmanagedType.LPStr)] string szComponent,   // LPCSTR
    [MarshalAs(UnmanagedType.LPStr)] string szUserSid,   // LPCSTR optional
    uint dwContext,   // DWORD
    uint dwProductIndex,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder szProductBuf,   // LPSTR optional, out
    IntPtr pdwInstalledContext,   // MSIINSTALLCONTEXT* optional, out
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder szSid,   // LPSTR optional, out
    IntPtr pcchSid   // DWORD* optional, in/out
);

<DllImport("msi.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function MsiEnumClientsExA(
    <MarshalAs(UnmanagedType.LPStr)> szComponent As String,   ' LPCSTR
    <MarshalAs(UnmanagedType.LPStr)> szUserSid As String,   ' LPCSTR optional
    dwContext As UInteger,   ' DWORD
    dwProductIndex As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> szProductBuf As System.Text.StringBuilder,   ' LPSTR optional, out
    pdwInstalledContext As IntPtr,   ' MSIINSTALLCONTEXT* optional, out
    <MarshalAs(UnmanagedType.LPStr)> szSid As System.Text.StringBuilder,   ' LPSTR optional, out
    pcchSid As IntPtr   ' DWORD* optional, in/out
) As UInteger
End Function

' szComponent : LPCSTR
' szUserSid : LPCSTR optional
' dwContext : DWORD
' dwProductIndex : DWORD
' szProductBuf : LPSTR optional, out
' pdwInstalledContext : MSIINSTALLCONTEXT* optional, out
' szSid : LPSTR optional, out
' pcchSid : DWORD* optional, in/out
Declare PtrSafe Function MsiEnumClientsExA Lib "msi" ( _
    ByVal szComponent As String, _
    ByVal szUserSid As String, _
    ByVal dwContext As Long, _
    ByVal dwProductIndex As Long, _
    ByVal szProductBuf As String, _
    ByVal pdwInstalledContext As LongPtr, _
    ByVal szSid As String, _
    ByVal pcchSid As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

MsiEnumClientsExA = ctypes.windll.msi.MsiEnumClientsExA
MsiEnumClientsExA.restype = wintypes.DWORD
MsiEnumClientsExA.argtypes = [
    wintypes.LPCSTR,  # szComponent : LPCSTR
    wintypes.LPCSTR,  # szUserSid : LPCSTR optional
    wintypes.DWORD,  # dwContext : DWORD
    wintypes.DWORD,  # dwProductIndex : DWORD
    wintypes.LPSTR,  # szProductBuf : LPSTR optional, out
    ctypes.c_void_p,  # pdwInstalledContext : MSIINSTALLCONTEXT* optional, out
    wintypes.LPSTR,  # szSid : LPSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcchSid : DWORD* optional, in/out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiEnumClientsExA = Fiddle::Function.new(
  lib['MsiEnumClientsExA'],
  [
    Fiddle::TYPE_VOIDP,  # szComponent : LPCSTR
    Fiddle::TYPE_VOIDP,  # szUserSid : LPCSTR optional
    -Fiddle::TYPE_INT,  # dwContext : DWORD
    -Fiddle::TYPE_INT,  # dwProductIndex : DWORD
    Fiddle::TYPE_VOIDP,  # szProductBuf : LPSTR optional, out
    Fiddle::TYPE_VOIDP,  # pdwInstalledContext : MSIINSTALLCONTEXT* optional, out
    Fiddle::TYPE_VOIDP,  # szSid : LPSTR optional, out
    Fiddle::TYPE_VOIDP,  # pcchSid : DWORD* optional, in/out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "msi")]
extern "system" {
    fn MsiEnumClientsExA(
        szComponent: *const u8,  // LPCSTR
        szUserSid: *const u8,  // LPCSTR optional
        dwContext: u32,  // DWORD
        dwProductIndex: u32,  // DWORD
        szProductBuf: *mut u8,  // LPSTR optional, out
        pdwInstalledContext: *mut i32,  // MSIINSTALLCONTEXT* optional, out
        szSid: *mut u8,  // LPSTR 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.Ansi)]
public static extern uint MsiEnumClientsExA([MarshalAs(UnmanagedType.LPStr)] string szComponent, [MarshalAs(UnmanagedType.LPStr)] string szUserSid, uint dwContext, uint dwProductIndex, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder szProductBuf, IntPtr pdwInstalledContext, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder szSid, IntPtr pcchSid);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiEnumClientsExA' -Namespace Win32 -PassThru
# $api::MsiEnumClientsExA(szComponent, szUserSid, dwContext, dwProductIndex, szProductBuf, pdwInstalledContext, szSid, pcchSid)

#uselib "msi.dll"
#func global MsiEnumClientsExA "MsiEnumClientsExA" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; MsiEnumClientsExA szComponent, szUserSid, dwContext, dwProductIndex, varptr(szProductBuf), pdwInstalledContext, varptr(szSid), varptr(pcchSid)   ; 戻り値は stat
; szComponent : LPCSTR -> "sptr"
; szUserSid : LPCSTR optional -> "sptr"
; dwContext : DWORD -> "sptr"
; dwProductIndex : DWORD -> "sptr"
; szProductBuf : LPSTR optional, out -> "sptr"
; pdwInstalledContext : MSIINSTALLCONTEXT* optional, out -> "sptr"
; szSid : LPSTR optional, out -> "sptr"
; pcchSid : DWORD* optional, in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

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

出力引数:

; DWORD MsiEnumClientsExA(LPCSTR szComponent, LPCSTR szUserSid, DWORD dwContext, DWORD dwProductIndex, LPSTR szProductBuf, MSIINSTALLCONTEXT* pdwInstalledContext, LPSTR szSid, DWORD* pcchSid)
#uselib "msi.dll"
#cfunc global MsiEnumClientsExA "MsiEnumClientsExA" str, str, int, int, var, int, var, var
; res = MsiEnumClientsExA(szComponent, szUserSid, dwContext, dwProductIndex, szProductBuf, pdwInstalledContext, szSid, pcchSid)
; szComponent : LPCSTR -> "str"
; szUserSid : LPCSTR optional -> "str"
; dwContext : DWORD -> "int"
; dwProductIndex : DWORD -> "int"
; szProductBuf : LPSTR optional, out -> "var"
; pdwInstalledContext : MSIINSTALLCONTEXT* optional, out -> "int"
; szSid : LPSTR optional, out -> "var"
; pcchSid : DWORD* optional, in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; DWORD MsiEnumClientsExA(LPCSTR szComponent, LPCSTR szUserSid, DWORD dwContext, DWORD dwProductIndex, LPSTR szProductBuf, MSIINSTALLCONTEXT* pdwInstalledContext, LPSTR szSid, DWORD* pcchSid)
#uselib "msi.dll"
#cfunc global MsiEnumClientsExA "MsiEnumClientsExA" str, str, int, int, intptr, int, intptr, intptr
; res = MsiEnumClientsExA(szComponent, szUserSid, dwContext, dwProductIndex, varptr(szProductBuf), pdwInstalledContext, varptr(szSid), varptr(pcchSid))
; szComponent : LPCSTR -> "str"
; szUserSid : LPCSTR optional -> "str"
; dwContext : DWORD -> "int"
; dwProductIndex : DWORD -> "int"
; szProductBuf : LPSTR optional, out -> "intptr"
; pdwInstalledContext : MSIINSTALLCONTEXT* optional, out -> "int"
; szSid : LPSTR 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")
	procMsiEnumClientsExA = msi.NewProc("MsiEnumClientsExA")
)

// szComponent (LPCSTR), szUserSid (LPCSTR optional), dwContext (DWORD), dwProductIndex (DWORD), szProductBuf (LPSTR optional, out), pdwInstalledContext (MSIINSTALLCONTEXT* optional, out), szSid (LPSTR optional, out), pcchSid (DWORD* optional, in/out)
r1, _, err := procMsiEnumClientsExA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(szComponent))),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(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 MsiEnumClientsExA(
  szComponent: PAnsiChar;   // LPCSTR
  szUserSid: PAnsiChar;   // LPCSTR optional
  dwContext: DWORD;   // DWORD
  dwProductIndex: DWORD;   // DWORD
  szProductBuf: PAnsiChar;   // LPSTR optional, out
  pdwInstalledContext: Pointer;   // MSIINSTALLCONTEXT* optional, out
  szSid: PAnsiChar;   // LPSTR optional, out
  pcchSid: Pointer   // DWORD* optional, in/out
): DWORD; stdcall;
  external 'msi.dll' name 'MsiEnumClientsExA';

result := DllCall("msi\MsiEnumClientsExA"
    , "AStr", szComponent   ; LPCSTR
    , "AStr", szUserSid   ; LPCSTR optional
    , "UInt", dwContext   ; DWORD
    , "UInt", dwProductIndex   ; DWORD
    , "Ptr", szProductBuf   ; LPSTR optional, out
    , "Ptr", pdwInstalledContext   ; MSIINSTALLCONTEXT* optional, out
    , "Ptr", szSid   ; LPSTR optional, out
    , "Ptr", pcchSid   ; DWORD* optional, in/out
    , "UInt")   ; return: DWORD

●MsiEnumClientsExA(szComponent, szUserSid, dwContext, dwProductIndex, szProductBuf, pdwInstalledContext, szSid, pcchSid) = DLL("msi.dll", "dword MsiEnumClientsExA(char*, char*, dword, dword, char*, void*, char*, void*)")
# 呼び出し: MsiEnumClientsExA(szComponent, szUserSid, dwContext, dwProductIndex, szProductBuf, pdwInstalledContext, szSid, pcchSid)
# szComponent : LPCSTR -> "char*"
# szUserSid : LPCSTR optional -> "char*"
# dwContext : DWORD -> "dword"
# dwProductIndex : DWORD -> "dword"
# szProductBuf : LPSTR optional, out -> "char*"
# pdwInstalledContext : MSIINSTALLCONTEXT* optional, out -> "void*"
# szSid : LPSTR optional, out -> "char*"
# pcchSid : DWORD* optional, in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。