Win32 API 日本語リファレンス
ホーム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
);

パラメーター

名前方向説明
szComponentLPCSTRinコンポーネントを識別するコンポーネントコード GUID です。この関数は、このコンポーネントを使用するアプリケーションを列挙します。
szUserSidLPCSTRinoptional

セキュリティ識別子 (SID) を含む、NULL で終わる文字列値です。アプリケーションの列挙は、この SID で識別されるユーザーに対して行われます。特殊な SID 文字列 s-1-1-0 (Everyone) は、システム内のすべてのユーザーのすべてのアプリケーションを列挙します。s-1-1-0 以外の SID 値は特定ユーザーのユーザー SID を指定し、その指定したユーザーがインストールしたアプリケーションのインスタンスを列挙します。

SID の種類 意味
NULL
現在ログオンしているユーザーを指定します。
User SID
特定のユーザーに対する列挙を指定します。ユーザー SID の例としては "S-1-3-64-2415071341-1358098788-3127455600-2561" などがあります。
s-1-1-0
システム内のすべてのユーザーに対する列挙を指定します。
注意 特殊な SID 文字列 s-1-5-18 (System) は、ユーザー単位ではなくコンピューター単位 (per-machine) のインストールコンテキストに存在するアプリケーションの列挙には使用できません。SID 値を s-1-5-18 に設定すると ERROR_INVALID_PARAMETER が返ります。dwContextMSIINSTALLCONTEXT_MACHINE のみに設定する場合、szUserSid の値は NULL でなければなりません。
dwContextDWORDin

列挙を、指定したインストールコンテキストにインストールされたアプリケーションのインスタンスに拡張するフラグです。列挙には、szUserSid で識別されるユーザーがインストールしたアプリケーションのインスタンスのみが含まれます。

次の値の組み合わせを指定できます。

コンテキスト 意味
MSIINSTALLCONTEXT_USERMANAGED
1
ユーザー単位の管理対象 (per-user-managed) インストールコンテキストにインストールされたアプリケーションを含めます。
MSIINSTALLCONTEXT_USERUNMANAGED
2
ユーザー単位の非管理対象 (per-user-unmanaged) インストールコンテキストにインストールされたアプリケーションを含めます。
MSIINSTALLCONTEXT_MACHINE
4
コンピューター単位 (per-machine) のインストールコンテキストにインストールされたアプリケーションを含めます。dwInstallContextMSIINSTALLCONTEXT_MACHINE のみに設定する場合、szUserSID パラメーターの値は NULL でなければなりません。
dwProductIndexDWORDin取得するアプリケーションのインデックスを指定します。このパラメーターの値は、関数の最初の呼び出しでは 0 (ゼロ) でなければなりません。以降の各呼び出しでは、インデックスを 1 ずつ増やす必要があります。インデックスを増やすのは、直前の関数呼び出しが ERROR_SUCCESS を返した場合のみにしてください。
szProductBufLPSTRoutoptionalアプリケーションの製品コードを受け取る文字列値です。この場所のバッファーは、製品コードを含む NULL で終わる文字列値を保持できる十分な長さが必要です。先頭の 38 個の TCHAR 文字がコンポーネントの GUID を受け取り、39 文字目が終端の NULL 文字を受け取ります。
pdwInstalledContextMSIINSTALLCONTEXT*outoptional

アプリケーションのインストールコンテキストを示すフラグです。

次の値の組み合わせを指定できます。

コンテキスト 意味
MSIINSTALLCONTEXT_USERMANAGED
1
アプリケーションはユーザー単位の管理対象 (per-user-managed) インストールコンテキストにインストールされています。
MSIINSTALLCONTEXT_USERUNMANAGED
2
アプリケーションはユーザー単位の非管理対象 (per-user-unmanaged) インストールコンテキストにインストールされています。
MSIINSTALLCONTEXT_MACHINE
4
アプリケーションはコンピューター単位 (per-machine) のインストールコンテキストにあります。
szSidLPSTRoutoptional

アプリケーションをインストールしたユーザーを識別するセキュリティ識別子 (SID) を受け取ります。このアプリケーションのインスタンスがコンピューター単位 (per-machine) のインストールコンテキストに存在する場合、この場所は空の文字列値を受け取ります。

バッファーの長さは、SID を含む NULL で終わる文字列値を保持できる十分な長さが必要です。バッファーが小さすぎる場合、関数は ERROR_MORE_DATA を返し、pcchSid が指す場所には、終端の NULL 文字を含まない SID 内の TCHAR 数が格納されます。

szSidNULL に設定され、かつ pcchSid がメモリ上の有効な場所を指すポインターである場合、関数は ERROR_SUCCESS を返し、その場所には終端の NULL 文字を含まない SID 内の TCHAR 数が格納されます。その後、szSid バッファーを *pcchSid + 1 文字を格納できる十分な大きさにリサイズして、値を取得するために関数を再度呼び出すことができます。

SID の種類 意味
空の文字列
アプリケーションはコンピューター単位 (per-machine) のインストールコンテキストにインストールされています。
User SID
製品をインストールしたユーザーの SID です。
pcchSidDWORD*inoutoptional

終端の NULL 文字を含まない SID 内の TCHAR 数を指定する変数を格納する、メモリ上の場所へのポインターです。関数が戻るとき、この変数は、SID と終端の NULL 文字を szSid が指すバッファーの場所に正常にコピーできたかどうかにかかわらず、要求された SID のサイズに設定されます。サイズは、終端の NULL 文字を含まない、要求された値内の TCHAR 数として返されます。

このパラメーターを NULL に設定できるのは、szSidNULL の場合のみです。それ以外の場合、関数は ERROR_INVALID_PARAMETER を返します。szSidpcchSid の両方が NULL に設定されている場合、関数は SID が存在すれば、SID 値を取得せずに ERROR_SUCCESS を返します。

戻り値の型: DWORD

公式ドキュメント

MsiEnumClientsEx 関数は、指定したコンポーネントを使用しているインストール済みアプリケーションを列挙します。この関数は、呼び出されるたびにアプリケーションの製品コードを 1 つ取得します。(ANSI)

戻り値

MsiEnumClientsEx 関数は、次のいずれかの値を返します。

戻り値 説明
ERROR_ACCESS_DENIED
現在のユーザー以外のユーザーがインストールしたアプリケーションのコンポーネントを列挙するには、管理者権限が必要です。
ERROR_BAD_CONFIGURATION
構成データが破損しています。
ERROR_INVALID_PARAMETER
無効なパラメーターが関数に渡されました。
ERROR_NO_MORE_ITEMS
列挙するアプリケーションがこれ以上ありません。
ERROR_SUCCESS
関数は成功しました。
ERROR_MORE_DATA
指定されたバッファーが、値全体を保持するには小さすぎました。
ERROR_FUNCTION_FAILED
関数は失敗しました。

解説(Remarks)

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 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), varptr(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, var, 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 -> "var"
; 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, var, var, 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 -> "var"
; szSid : LPSTR optional, out -> "var"
; pcchSid : DWORD* optional, in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。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)。
const std = @import("std");

extern "msi" fn MsiEnumClientsExA(
    szComponent: [*c]const u8, // LPCSTR
    szUserSid: [*c]const u8, // LPCSTR optional
    dwContext: u32, // DWORD
    dwProductIndex: u32, // DWORD
    szProductBuf: [*c]u8, // LPSTR optional, out
    pdwInstalledContext: [*c]i32, // MSIINSTALLCONTEXT* optional, out
    szSid: [*c]u8, // LPSTR optional, out
    pcchSid: [*c]u32 // DWORD* optional, in/out
) callconv(std.os.windows.WINAPI) u32;
proc MsiEnumClientsExA(
    szComponent: cstring,  # LPCSTR
    szUserSid: cstring,  # LPCSTR optional
    dwContext: uint32,  # DWORD
    dwProductIndex: uint32,  # DWORD
    szProductBuf: ptr char,  # LPSTR optional, out
    pdwInstalledContext: ptr int32,  # MSIINSTALLCONTEXT* optional, out
    szSid: ptr char,  # LPSTR optional, out
    pcchSid: ptr uint32  # DWORD* optional, in/out
): uint32 {.importc: "MsiEnumClientsExA", stdcall, dynlib: "msi.dll".}
pragma(lib, "msi");
extern(Windows)
uint MsiEnumClientsExA(
    const(char)* szComponent,   // LPCSTR
    const(char)* szUserSid,   // LPCSTR optional
    uint dwContext,   // DWORD
    uint dwProductIndex,   // DWORD
    char* szProductBuf,   // LPSTR optional, out
    int* pdwInstalledContext,   // MSIINSTALLCONTEXT* optional, out
    char* szSid,   // LPSTR optional, out
    uint* pcchSid   // DWORD* optional, in/out
);
ccall((:MsiEnumClientsExA, "msi.dll"), stdcall, UInt32,
      (Cstring, Cstring, UInt32, UInt32, Ptr{UInt8}, Ptr{Int32}, Ptr{UInt8}, Ptr{UInt32}),
      szComponent, szUserSid, dwContext, dwProductIndex, szProductBuf, pdwInstalledContext, szSid, pcchSid)
# szComponent : LPCSTR -> Cstring
# szUserSid : LPCSTR optional -> Cstring
# dwContext : DWORD -> UInt32
# dwProductIndex : DWORD -> UInt32
# szProductBuf : LPSTR optional, out -> Ptr{UInt8}
# pdwInstalledContext : MSIINSTALLCONTEXT* optional, out -> Ptr{Int32}
# szSid : LPSTR optional, out -> Ptr{UInt8}
# pcchSid : DWORD* optional, in/out -> Ptr{UInt32}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t MsiEnumClientsExA(
    const char* szComponent,
    const char* szUserSid,
    uint32_t dwContext,
    uint32_t dwProductIndex,
    char* szProductBuf,
    int32_t* pdwInstalledContext,
    char* szSid,
    uint32_t* pcchSid);
]]
local msi = ffi.load("msi")
-- msi.MsiEnumClientsExA(szComponent, szUserSid, dwContext, dwProductIndex, szProductBuf, pdwInstalledContext, szSid, pcchSid)
-- 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
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('msi.dll');
const MsiEnumClientsExA = lib.func('__stdcall', 'MsiEnumClientsExA', 'uint32_t', ['str', 'str', 'uint32_t', 'uint32_t', 'char *', 'int32_t *', 'char *', 'uint32_t *']);
// MsiEnumClientsExA(szComponent, szUserSid, dwContext, dwProductIndex, szProductBuf, pdwInstalledContext, szSid, pcchSid)
// szComponent : LPCSTR -> 'str'
// szUserSid : LPCSTR optional -> 'str'
// dwContext : DWORD -> 'uint32_t'
// dwProductIndex : DWORD -> 'uint32_t'
// szProductBuf : LPSTR optional, out -> 'char *'
// pdwInstalledContext : MSIINSTALLCONTEXT* optional, out -> 'int32_t *'
// szSid : LPSTR optional, out -> 'char *'
// pcchSid : DWORD* optional, in/out -> 'uint32_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("msi.dll", {
  MsiEnumClientsExA: { parameters: ["buffer", "buffer", "u32", "u32", "buffer", "pointer", "buffer", "pointer"], result: "u32" },
});
// lib.symbols.MsiEnumClientsExA(szComponent, szUserSid, dwContext, dwProductIndex, szProductBuf, pdwInstalledContext, szSid, pcchSid)
// szComponent : LPCSTR -> "buffer"
// szUserSid : LPCSTR optional -> "buffer"
// dwContext : DWORD -> "u32"
// dwProductIndex : DWORD -> "u32"
// szProductBuf : LPSTR optional, out -> "buffer"
// pdwInstalledContext : MSIINSTALLCONTEXT* optional, out -> "pointer"
// szSid : LPSTR optional, out -> "buffer"
// pcchSid : DWORD* optional, in/out -> "pointer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t MsiEnumClientsExA(
    const char* szComponent,
    const char* szUserSid,
    uint32_t dwContext,
    uint32_t dwProductIndex,
    char* szProductBuf,
    int32_t* pdwInstalledContext,
    char* szSid,
    uint32_t* pcchSid);
C, "msi.dll");
// $ffi->MsiEnumClientsExA(szComponent, szUserSid, dwContext, dwProductIndex, szProductBuf, pdwInstalledContext, szSid, pcchSid);
// 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
// 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
// WINAPI(stdcall): x64 では呼出規約が統一されるため問題なし。x86 では __stdcall 対応のラッパが必要な場合あり。
import com.sun.jna.*;
import com.sun.jna.ptr.*;
import com.sun.jna.win32.StdCallLibrary;
import com.sun.jna.win32.W32APIOptions;

public interface Msi extends StdCallLibrary {
    Msi INSTANCE = Native.load("msi", Msi.class, W32APIOptions.ASCII_OPTIONS);
    int MsiEnumClientsExA(
        String szComponent,   // LPCSTR
        String szUserSid,   // LPCSTR optional
        int dwContext,   // DWORD
        int dwProductIndex,   // DWORD
        byte[] szProductBuf,   // LPSTR optional, out
        IntByReference pdwInstalledContext,   // MSIINSTALLCONTEXT* optional, out
        byte[] szSid,   // LPSTR optional, out
        IntByReference pcchSid   // DWORD* optional, in/out
    );
}
@[Link("msi")]
lib Libmsi
  fun MsiEnumClientsExA = MsiEnumClientsExA(
    szComponent : UInt8*,   # LPCSTR
    szUserSid : UInt8*,   # LPCSTR optional
    dwContext : UInt32,   # DWORD
    dwProductIndex : UInt32,   # DWORD
    szProductBuf : UInt8*,   # LPSTR optional, out
    pdwInstalledContext : Int32*,   # MSIINSTALLCONTEXT* optional, out
    szSid : UInt8*,   # LPSTR optional, out
    pcchSid : UInt32*   # DWORD* optional, in/out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef MsiEnumClientsExANative = Uint32 Function(Pointer<Utf8>, Pointer<Utf8>, Uint32, Uint32, Pointer<Utf8>, Pointer<Int32>, Pointer<Utf8>, Pointer<Uint32>);
typedef MsiEnumClientsExADart = int Function(Pointer<Utf8>, Pointer<Utf8>, int, int, Pointer<Utf8>, Pointer<Int32>, Pointer<Utf8>, Pointer<Uint32>);
final MsiEnumClientsExA = DynamicLibrary.open('msi.dll')
    .lookupFunction<MsiEnumClientsExANative, MsiEnumClientsExADart>('MsiEnumClientsExA');
// szComponent : LPCSTR -> Pointer<Utf8>
// szUserSid : LPCSTR optional -> Pointer<Utf8>
// dwContext : DWORD -> Uint32
// dwProductIndex : DWORD -> Uint32
// szProductBuf : LPSTR optional, out -> Pointer<Utf8>
// pdwInstalledContext : MSIINSTALLCONTEXT* optional, out -> Pointer<Int32>
// szSid : LPSTR optional, out -> Pointer<Utf8>
// pcchSid : DWORD* optional, in/out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
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';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "MsiEnumClientsExA"
  c_MsiEnumClientsExA :: CString -> CString -> Word32 -> Word32 -> CString -> Ptr Int32 -> CString -> Ptr Word32 -> IO Word32
-- szComponent : LPCSTR -> CString
-- szUserSid : LPCSTR optional -> CString
-- dwContext : DWORD -> Word32
-- dwProductIndex : DWORD -> Word32
-- szProductBuf : LPSTR optional, out -> CString
-- pdwInstalledContext : MSIINSTALLCONTEXT* optional, out -> Ptr Int32
-- szSid : LPSTR optional, out -> CString
-- pcchSid : DWORD* optional, in/out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let msienumclientsexa =
  foreign "MsiEnumClientsExA"
    (string @-> string @-> uint32_t @-> uint32_t @-> string @-> (ptr int32_t) @-> string @-> (ptr uint32_t) @-> returning uint32_t)
(* szComponent : LPCSTR -> string *)
(* szUserSid : LPCSTR optional -> string *)
(* dwContext : DWORD -> uint32_t *)
(* dwProductIndex : DWORD -> uint32_t *)
(* szProductBuf : LPSTR optional, out -> string *)
(* pdwInstalledContext : MSIINSTALLCONTEXT* optional, out -> (ptr int32_t) *)
(* szSid : LPSTR optional, out -> string *)
(* pcchSid : DWORD* optional, in/out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library msi (t "msi.dll"))
(cffi:use-foreign-library msi)

(cffi:defcfun ("MsiEnumClientsExA" msi-enum-clients-ex-a :convention :stdcall) :uint32
  (sz-component :string)   ; LPCSTR
  (sz-user-sid :string)   ; LPCSTR optional
  (dw-context :uint32)   ; DWORD
  (dw-product-index :uint32)   ; DWORD
  (sz-product-buf :pointer)   ; LPSTR optional, out
  (pdw-installed-context :pointer)   ; MSIINSTALLCONTEXT* optional, out
  (sz-sid :pointer)   ; LPSTR optional, out
  (pcch-sid :pointer))   ; DWORD* optional, in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MsiEnumClientsExA = Win32::API::More->new('msi',
    'DWORD MsiEnumClientsExA(LPCSTR szComponent, LPCSTR szUserSid, DWORD dwContext, DWORD dwProductIndex, LPSTR szProductBuf, LPVOID pdwInstalledContext, LPSTR szSid, LPVOID pcchSid)');
# my $ret = $MsiEnumClientsExA->Call($szComponent, $szUserSid, $dwContext, $dwProductIndex, $szProductBuf, $pdwInstalledContext, $szSid, $pcchSid);
# szComponent : LPCSTR -> LPCSTR
# szUserSid : LPCSTR optional -> LPCSTR
# dwContext : DWORD -> DWORD
# dwProductIndex : DWORD -> DWORD
# szProductBuf : LPSTR optional, out -> LPSTR
# pdwInstalledContext : MSIINSTALLCONTEXT* optional, out -> LPVOID
# szSid : LPSTR optional, out -> LPSTR
# pcchSid : DWORD* optional, in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
類似 API
使用する型