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

MsiEnumComponentsExA

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

シグネチャ

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

DWORD MsiEnumComponentsExA(
    LPCSTR szUserSid,   // optional
    DWORD dwContext,
    DWORD dwIndex,
    LPSTR szInstalledComponentCode,   // optional
    MSIINSTALLCONTEXT* pdwInstalledContext,   // optional
    LPSTR szSid,   // optional
    DWORD* pcchSid   // optional
);

パラメーター

名前方向説明
szUserSidLPCSTRinoptional

セキュリティ識別子 (SID) を含む、null で終わる文字列です。インストール済みコンポーネントの列挙は、この SID で識別されるユーザーにまで及びます。特別な SID 文字列 s-1-1-0 (Everyone) は、システム内のすべてのユーザーのすべての製品にわたって、インストール済みのすべてのコンポーネントを列挙することを指定します。s-1-1-0 以外の SID 値は、特定のユーザーのユーザー SID を指定し、列挙対象を、指定したユーザーがインストールしたアプリケーションのインスタンスに限定します。

SID type Meaning
NULL
現在ログオンしているユーザーを指定します。
User SID
システム内の特定のユーザーに対する列挙です。ユーザー SID の例として "S-1-3-64-2415071341-1358098788-3127455600-2561" が挙げられます。
s-1-1-0
システム内のすべてのユーザーを指定します。
Note

特別な SID 文字列 s-1-5-18 (System) は、ユーザー単位 (per-machine) のインストールコンテキストにインストールされたアプリケーションの列挙には使用できません。SID 値を s-1-5-18 に設定すると ERROR_INVALID_PARAMETER が返されます。dwContextMSIINSTALLCONTEXT_MACHINE のみに設定されている場合、szUserSidNULL でなければなりません。

dwContextDWORDin

インストール済みコンポーネントの列挙を、指定したインストールコンテキストにインストールされた製品のインスタンスに限定するフラグです。列挙対象には、szUserSid で指定されたユーザーがインストールした製品インスタンスのみが含まれます。

Flag Meaning
MSIINSTALLCONTEXT_USERMANAGED
1
ユーザー単位の管理対象 (per-user-managed) インストールコンテキストに存在する製品を含めます。
MSIINSTALLCONTEXT_USERUNMANAGED
2
ユーザー単位の非管理対象 (per-user-unmanaged) インストールコンテキストに存在する製品を含めます。
MSIINSTALLCONTEXT_MACHINE
4
マシン単位 (per-machine) インストールコンテキストに存在する製品を含めます。dwInstallContextMSIINSTALLCONTEXT_MACHINE のみに設定されている場合、szUserSID パラメーターは NULL でなければなりません。
dwIndexDWORDin取得するコンポーネントのインデックスを指定します。MsiEnumComponentsEx 関数の最初の呼び出しでは、このパラメーターをゼロ (0) にする必要があります。以降の各呼び出しでは、インデックスを 1 ずつ増やす必要があります。インデックスを増やすのは、前回の関数呼び出しが ERROR_SUCCESS を返した場合のみとしてください。 コンポーネントには順序がなく、関数によって任意の順序で返される場合があります。
szInstalledComponentCodeLPSTRoutoptionalインストール済みコンポーネントのコンポーネントコード GUID を受け取る出力バッファーです。バッファーの長さは、コンポーネントコードを含む null で終わる文字列値を格納できる十分な大きさにする必要があります。最初の 38 文字 (TCHAR) にコンポーネントの GUID が格納され、39 文字目に終端の NULL 文字が格納されます。
pdwInstalledContextMSIINSTALLCONTEXT*outoptional

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

Flag Meaning
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 type Meaning
Empty string
アプリケーションはマシン単位 (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

公式ドキュメント

MsiEnumComponentsEx 関数は、インストール済みのコンポーネントを列挙します。この関数は、呼び出されるたびに 1 つのコンポーネントのコンポーネントコードを取得します。コンポーネントコードは、コンポーネント、バージョン、言語ごとに一意の文字列形式の GUID です。(ANSI)

戻り値

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

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

解説(Remarks)

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 MsiEnumComponentsExA(
    LPCSTR szUserSid,   // optional
    DWORD dwContext,
    DWORD dwIndex,
    LPSTR szInstalledComponentCode,   // optional
    MSIINSTALLCONTEXT* pdwInstalledContext,   // optional
    LPSTR szSid,   // optional
    DWORD* pcchSid   // optional
);
[DllImport("msi.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint MsiEnumComponentsExA(
    [MarshalAs(UnmanagedType.LPStr)] string szUserSid,   // LPCSTR optional
    uint dwContext,   // DWORD
    uint dwIndex,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder szInstalledComponentCode,   // 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 MsiEnumComponentsExA(
    <MarshalAs(UnmanagedType.LPStr)> szUserSid As String,   ' LPCSTR optional
    dwContext As UInteger,   ' DWORD
    dwIndex As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> szInstalledComponentCode 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
' szUserSid : LPCSTR optional
' dwContext : DWORD
' dwIndex : DWORD
' szInstalledComponentCode : LPSTR optional, out
' pdwInstalledContext : MSIINSTALLCONTEXT* optional, out
' szSid : LPSTR optional, out
' pcchSid : DWORD* optional, in/out
Declare PtrSafe Function MsiEnumComponentsExA Lib "msi" ( _
    ByVal szUserSid As String, _
    ByVal dwContext As Long, _
    ByVal dwIndex As Long, _
    ByVal szInstalledComponentCode 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

MsiEnumComponentsExA = ctypes.windll.msi.MsiEnumComponentsExA
MsiEnumComponentsExA.restype = wintypes.DWORD
MsiEnumComponentsExA.argtypes = [
    wintypes.LPCSTR,  # szUserSid : LPCSTR optional
    wintypes.DWORD,  # dwContext : DWORD
    wintypes.DWORD,  # dwIndex : DWORD
    wintypes.LPSTR,  # szInstalledComponentCode : 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')
MsiEnumComponentsExA = Fiddle::Function.new(
  lib['MsiEnumComponentsExA'],
  [
    Fiddle::TYPE_VOIDP,  # szUserSid : LPCSTR optional
    -Fiddle::TYPE_INT,  # dwContext : DWORD
    -Fiddle::TYPE_INT,  # dwIndex : DWORD
    Fiddle::TYPE_VOIDP,  # szInstalledComponentCode : 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 MsiEnumComponentsExA(
        szUserSid: *const u8,  // LPCSTR optional
        dwContext: u32,  // DWORD
        dwIndex: u32,  // DWORD
        szInstalledComponentCode: *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 MsiEnumComponentsExA([MarshalAs(UnmanagedType.LPStr)] string szUserSid, uint dwContext, uint dwIndex, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder szInstalledComponentCode, IntPtr pdwInstalledContext, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder szSid, IntPtr pcchSid);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiEnumComponentsExA' -Namespace Win32 -PassThru
# $api::MsiEnumComponentsExA(szUserSid, dwContext, dwIndex, szInstalledComponentCode, pdwInstalledContext, szSid, pcchSid)
#uselib "msi.dll"
#func global MsiEnumComponentsExA "MsiEnumComponentsExA" sptr, sptr, sptr, sptr, sptr, sptr, sptr
; MsiEnumComponentsExA szUserSid, dwContext, dwIndex, varptr(szInstalledComponentCode), varptr(pdwInstalledContext), varptr(szSid), varptr(pcchSid)   ; 戻り値は stat
; szUserSid : LPCSTR optional -> "sptr"
; dwContext : DWORD -> "sptr"
; dwIndex : DWORD -> "sptr"
; szInstalledComponentCode : 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 MsiEnumComponentsExA "MsiEnumComponentsExA" str, int, int, var, var, var, var
; res = MsiEnumComponentsExA(szUserSid, dwContext, dwIndex, szInstalledComponentCode, pdwInstalledContext, szSid, pcchSid)
; szUserSid : LPCSTR optional -> "str"
; dwContext : DWORD -> "int"
; dwIndex : DWORD -> "int"
; szInstalledComponentCode : LPSTR optional, out -> "var"
; pdwInstalledContext : MSIINSTALLCONTEXT* optional, out -> "var"
; szSid : LPSTR optional, out -> "var"
; pcchSid : DWORD* optional, in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD MsiEnumComponentsExA(LPCSTR szUserSid, DWORD dwContext, DWORD dwIndex, LPSTR szInstalledComponentCode, MSIINSTALLCONTEXT* pdwInstalledContext, LPSTR szSid, DWORD* pcchSid)
#uselib "msi.dll"
#cfunc global MsiEnumComponentsExA "MsiEnumComponentsExA" str, int, int, var, var, var, var
; res = MsiEnumComponentsExA(szUserSid, dwContext, dwIndex, szInstalledComponentCode, pdwInstalledContext, szSid, pcchSid)
; szUserSid : LPCSTR optional -> "str"
; dwContext : DWORD -> "int"
; dwIndex : DWORD -> "int"
; szInstalledComponentCode : 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")
	procMsiEnumComponentsExA = msi.NewProc("MsiEnumComponentsExA")
)

// szUserSid (LPCSTR optional), dwContext (DWORD), dwIndex (DWORD), szInstalledComponentCode (LPSTR optional, out), pdwInstalledContext (MSIINSTALLCONTEXT* optional, out), szSid (LPSTR optional, out), pcchSid (DWORD* optional, in/out)
r1, _, err := procMsiEnumComponentsExA.Call(
	uintptr(unsafe.Pointer(windows.BytePtrFromString(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 MsiEnumComponentsExA(
  szUserSid: PAnsiChar;   // LPCSTR optional
  dwContext: DWORD;   // DWORD
  dwIndex: DWORD;   // DWORD
  szInstalledComponentCode: 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 'MsiEnumComponentsExA';
result := DllCall("msi\MsiEnumComponentsExA"
    , "AStr", szUserSid   ; LPCSTR optional
    , "UInt", dwContext   ; DWORD
    , "UInt", dwIndex   ; DWORD
    , "Ptr", szInstalledComponentCode   ; LPSTR optional, out
    , "Ptr", pdwInstalledContext   ; MSIINSTALLCONTEXT* optional, out
    , "Ptr", szSid   ; LPSTR optional, out
    , "Ptr", pcchSid   ; DWORD* optional, in/out
    , "UInt")   ; return: DWORD
●MsiEnumComponentsExA(szUserSid, dwContext, dwIndex, szInstalledComponentCode, pdwInstalledContext, szSid, pcchSid) = DLL("msi.dll", "dword MsiEnumComponentsExA(char*, dword, dword, char*, void*, char*, void*)")
# 呼び出し: MsiEnumComponentsExA(szUserSid, dwContext, dwIndex, szInstalledComponentCode, pdwInstalledContext, szSid, pcchSid)
# szUserSid : LPCSTR optional -> "char*"
# dwContext : DWORD -> "dword"
# dwIndex : DWORD -> "dword"
# szInstalledComponentCode : 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 MsiEnumComponentsExA(
    szUserSid: [*c]const u8, // LPCSTR optional
    dwContext: u32, // DWORD
    dwIndex: u32, // DWORD
    szInstalledComponentCode: [*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 MsiEnumComponentsExA(
    szUserSid: cstring,  # LPCSTR optional
    dwContext: uint32,  # DWORD
    dwIndex: uint32,  # DWORD
    szInstalledComponentCode: 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: "MsiEnumComponentsExA", stdcall, dynlib: "msi.dll".}
pragma(lib, "msi");
extern(Windows)
uint MsiEnumComponentsExA(
    const(char)* szUserSid,   // LPCSTR optional
    uint dwContext,   // DWORD
    uint dwIndex,   // DWORD
    char* szInstalledComponentCode,   // LPSTR optional, out
    int* pdwInstalledContext,   // MSIINSTALLCONTEXT* optional, out
    char* szSid,   // LPSTR optional, out
    uint* pcchSid   // DWORD* optional, in/out
);
ccall((:MsiEnumComponentsExA, "msi.dll"), stdcall, UInt32,
      (Cstring, UInt32, UInt32, Ptr{UInt8}, Ptr{Int32}, Ptr{UInt8}, Ptr{UInt32}),
      szUserSid, dwContext, dwIndex, szInstalledComponentCode, pdwInstalledContext, szSid, pcchSid)
# szUserSid : LPCSTR optional -> Cstring
# dwContext : DWORD -> UInt32
# dwIndex : DWORD -> UInt32
# szInstalledComponentCode : 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 MsiEnumComponentsExA(
    const char* szUserSid,
    uint32_t dwContext,
    uint32_t dwIndex,
    char* szInstalledComponentCode,
    int32_t* pdwInstalledContext,
    char* szSid,
    uint32_t* pcchSid);
]]
local msi = ffi.load("msi")
-- msi.MsiEnumComponentsExA(szUserSid, dwContext, dwIndex, szInstalledComponentCode, pdwInstalledContext, szSid, pcchSid)
-- szUserSid : LPCSTR optional
-- dwContext : DWORD
-- dwIndex : DWORD
-- szInstalledComponentCode : 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 MsiEnumComponentsExA = lib.func('__stdcall', 'MsiEnumComponentsExA', 'uint32_t', ['str', 'uint32_t', 'uint32_t', 'char *', 'int32_t *', 'char *', 'uint32_t *']);
// MsiEnumComponentsExA(szUserSid, dwContext, dwIndex, szInstalledComponentCode, pdwInstalledContext, szSid, pcchSid)
// szUserSid : LPCSTR optional -> 'str'
// dwContext : DWORD -> 'uint32_t'
// dwIndex : DWORD -> 'uint32_t'
// szInstalledComponentCode : 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", {
  MsiEnumComponentsExA: { parameters: ["buffer", "u32", "u32", "buffer", "pointer", "buffer", "pointer"], result: "u32" },
});
// lib.symbols.MsiEnumComponentsExA(szUserSid, dwContext, dwIndex, szInstalledComponentCode, pdwInstalledContext, szSid, pcchSid)
// szUserSid : LPCSTR optional -> "buffer"
// dwContext : DWORD -> "u32"
// dwIndex : DWORD -> "u32"
// szInstalledComponentCode : 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 MsiEnumComponentsExA(
    const char* szUserSid,
    uint32_t dwContext,
    uint32_t dwIndex,
    char* szInstalledComponentCode,
    int32_t* pdwInstalledContext,
    char* szSid,
    uint32_t* pcchSid);
C, "msi.dll");
// $ffi->MsiEnumComponentsExA(szUserSid, dwContext, dwIndex, szInstalledComponentCode, pdwInstalledContext, szSid, pcchSid);
// szUserSid : LPCSTR optional
// dwContext : DWORD
// dwIndex : DWORD
// szInstalledComponentCode : 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 MsiEnumComponentsExA(
        String szUserSid,   // LPCSTR optional
        int dwContext,   // DWORD
        int dwIndex,   // DWORD
        byte[] szInstalledComponentCode,   // LPSTR optional, out
        IntByReference pdwInstalledContext,   // MSIINSTALLCONTEXT* optional, out
        byte[] szSid,   // LPSTR optional, out
        IntByReference pcchSid   // DWORD* optional, in/out
    );
}
@[Link("msi")]
lib Libmsi
  fun MsiEnumComponentsExA = MsiEnumComponentsExA(
    szUserSid : UInt8*,   # LPCSTR optional
    dwContext : UInt32,   # DWORD
    dwIndex : UInt32,   # DWORD
    szInstalledComponentCode : 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 MsiEnumComponentsExANative = Uint32 Function(Pointer<Utf8>, Uint32, Uint32, Pointer<Utf8>, Pointer<Int32>, Pointer<Utf8>, Pointer<Uint32>);
typedef MsiEnumComponentsExADart = int Function(Pointer<Utf8>, int, int, Pointer<Utf8>, Pointer<Int32>, Pointer<Utf8>, Pointer<Uint32>);
final MsiEnumComponentsExA = DynamicLibrary.open('msi.dll')
    .lookupFunction<MsiEnumComponentsExANative, MsiEnumComponentsExADart>('MsiEnumComponentsExA');
// szUserSid : LPCSTR optional -> Pointer<Utf8>
// dwContext : DWORD -> Uint32
// dwIndex : DWORD -> Uint32
// szInstalledComponentCode : 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 MsiEnumComponentsExA(
  szUserSid: PAnsiChar;   // LPCSTR optional
  dwContext: DWORD;   // DWORD
  dwIndex: DWORD;   // DWORD
  szInstalledComponentCode: 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 'MsiEnumComponentsExA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "MsiEnumComponentsExA"
  c_MsiEnumComponentsExA :: CString -> Word32 -> Word32 -> CString -> Ptr Int32 -> CString -> Ptr Word32 -> IO Word32
-- szUserSid : LPCSTR optional -> CString
-- dwContext : DWORD -> Word32
-- dwIndex : DWORD -> Word32
-- szInstalledComponentCode : 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 msienumcomponentsexa =
  foreign "MsiEnumComponentsExA"
    (string @-> uint32_t @-> uint32_t @-> string @-> (ptr int32_t) @-> string @-> (ptr uint32_t) @-> returning uint32_t)
(* szUserSid : LPCSTR optional -> string *)
(* dwContext : DWORD -> uint32_t *)
(* dwIndex : DWORD -> uint32_t *)
(* szInstalledComponentCode : 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 ("MsiEnumComponentsExA" msi-enum-components-ex-a :convention :stdcall) :uint32
  (sz-user-sid :string)   ; LPCSTR optional
  (dw-context :uint32)   ; DWORD
  (dw-index :uint32)   ; DWORD
  (sz-installed-component-code :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 $MsiEnumComponentsExA = Win32::API::More->new('msi',
    'DWORD MsiEnumComponentsExA(LPCSTR szUserSid, DWORD dwContext, DWORD dwIndex, LPSTR szInstalledComponentCode, LPVOID pdwInstalledContext, LPSTR szSid, LPVOID pcchSid)');
# my $ret = $MsiEnumComponentsExA->Call($szUserSid, $dwContext, $dwIndex, $szInstalledComponentCode, $pdwInstalledContext, $szSid, $pcchSid);
# szUserSid : LPCSTR optional -> LPCSTR
# dwContext : DWORD -> DWORD
# dwIndex : DWORD -> DWORD
# szInstalledComponentCode : 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
使用する型