MsiEnumProductsExA
関数シグネチャ
// msi.dll (ANSI / -A)
#include <windows.h>
DWORD MsiEnumProductsExA(
LPCSTR szProductCode, // optional
LPCSTR szUserSid, // optional
DWORD dwContext,
DWORD dwIndex,
LPSTR szInstalledProductCode, // optional
MSIINSTALLCONTEXT* pdwInstalledContext, // optional
LPSTR szSid, // optional
DWORD* pcchSid // optional
);パラメーター
| 名前 | 型 | 方向 | 説明 | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| szProductCode | LPCSTR | inoptional | 列挙する製品の ProductCode GUID。szUserSid および dwContext パラメーターで指定したコンテキストのスコープ内にある製品のインスタンスのみが列挙されます。このパラメーターを NULL に設定すると、指定したコンテキスト内のすべての製品が列挙されます。 | ||||||||
| szUserSid | LPCSTR | inoptional | 列挙のコンテキストを制限するセキュリティ識別子 (SID) を指定する、NULL 終端文字列。特別な SID 文字列 s-1-1-0 (Everyone) は、システム内のすべてのユーザーにわたる列挙を指定します。s-1-1-0 以外の SID 値はユーザー SID とみなされ、列挙を現在のユーザーまたはシステム内の任意のユーザーに制限します。このパラメーターを NULL に設定すると、列挙スコープが現在のユーザーに制限されます。
注意 特別な SID 文字列 s-1-5-18 (System) は、マシン単位でインストールされた製品やパッチの列挙には使用できません。dwContext を MSIINSTALLCONTEXT_MACHINE のみに設定する場合、szUserSid は NULL でなければなりません。
| ||||||||
| dwContext | DWORD | in | 列挙を特定のコンテキストに制限します。このパラメーターには、次の表に示す値のいずれか 1 つ、またはそれらの組み合わせを指定できます。
| ||||||||
| dwIndex | DWORD | in | 取得する製品のインデックスを指定します。このパラメーターは、MsiEnumProductsEx 関数の最初の呼び出しではゼロでなければならず、以降の呼び出しでは増分します。インデックスを増分するのは、直前の呼び出しが ERROR_SUCCESS を返した場合のみとしてください。製品は順序付けられていないため、新しい製品のインデックスは任意です。つまり、この関数は製品を任意の順序で返す可能性があります。 | ||||||||
| szInstalledProductCode | LPSTR | outoptional | 列挙される製品インスタンスの ProductCode GUID を表す、TCHAR の NULL 終端文字列。このパラメーターは NULL にできます。 | ||||||||
| pdwInstalledContext | MSIINSTALLCONTEXT* | outoptional | 列挙される製品インスタンスのコンテキストを返します。出力値は MSIINSTALLCONTEXT_USERMANAGED、MSIINSTALLCONTEXT_USERUNMANAGED、または MSIINSTALLCONTEXT_MACHINE のいずれかです。このパラメーターは NULL にできます。 | ||||||||
| szSid | LPSTR | outoptional | この製品インスタンスが存在するアカウントの文字列 SID を受け取る出力バッファー。マシン単位のコンテキストでインストールされたインスタンスの場合、このバッファーには空文字列が返されます。 このバッファーは SID を格納できる十分な大きさである必要があります。バッファーが小さすぎる場合、関数は ERROR_MORE_DATA を返し、*pcchSid を SID 内の TCHAR 数 (終端の NULL 文字を含まない) に設定します。 szSid を NULL に設定し、pcchSid を有効なポインターに設定した場合、関数は ERROR_SUCCESS を返し、pcchSid を値内の TCHAR 数 (終端の NULL を含まない) に設定します。その後、pcchSid + 1 文字を格納できる十分な大きさの szSid バッファーを用意して、関数を再度呼び出すことで値を取得できます。 szSid と pcchSid の両方を NULL に設定した場合、関数は値を取得せずに、値が存在すれば ERROR_SUCCESS を返します。 | ||||||||
| pcchSid | DWORD* | inoutoptional | 関数を呼び出すとき、このパラメーターは szSid バッファー内の TCHAR 数を指定する変数へのポインターである必要があります。関数が返ると、このパラメーターは、関数が値を指定バッファーにコピーしたかどうかにかかわらず、要求された値のサイズに設定されます。サイズは、要求された値の TCHAR 数 (終端の NULL 文字を含まない) として返されます。 このパラメーターを NULL に設定できるのは szSid も NULL の場合のみです。それ以外の場合、関数は ERROR_INVALID_PARAMETER を返します。 |
戻り値の型: DWORD
公式ドキュメント
指定したコンテキストで現在アドバタイズまたはインストールされている製品の、1 つまたはすべてのインスタンスを列挙します。(ANSI)
戻り値
MsiEnumProductsEx 関数は、次のいずれかの値を返します。
| 戻り値 | 説明 |
|---|---|
| スコープに現在のユーザー以外のユーザーが含まれる場合、管理者権限が必要です。 | |
| 構成データが破損しています。 | |
| 無効なパラメーターが関数に渡されました。 | |
| 列挙する製品はこれ以上ありません。 | |
| 製品が列挙されました。 | |
| szSid パラメーターが小さすぎてユーザー SID を取得できません。 | |
| その製品は、指定したコンテキストではコンピューターにインストールされていません。 | |
| 予期しない内部エラーです。 |
解説(Remarks)
製品を列挙するには、アプリケーションはまず iIndex パラメーターをゼロに設定して MsiEnumProductsEx 関数を呼び出す必要があります。その後、アプリケーションは iProductIndex パラメーターを増分しながら、MsiEnumProductsEx が ERROR_NO_MORE_ITEMS を返して列挙する製品がなくなるまで呼び出しを続けます。
すべての製品を列挙するために MsiEnumProductsEx を複数回呼び出す場合、各呼び出しは同じスレッドから行う必要があります。
すべてのユーザーアカウントにわたって製品を列挙する、または現在のユーザーアカウント以外のアカウントについて列挙するには、ユーザーは管理者権限を持っている必要があります。すべてのユーザーまたは現在のユーザー以外のユーザーにわたって列挙する場合、ユーザー単位の非管理対象 (per-user-unmanaged) コンテキストでアドバタイズのみされている (インストールされていないなど) 製品は、列挙でスキップされます。
MsiEnumProductsEx で列挙された各製品インスタンスの状態やその他の情報を取得するには、MsiGetProductInfoEx を使用します。
msi.h ヘッダーは MsiEnumProductsEx を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義します。エンコーディング非依存のエイリアスの使用を、エンコーディング非依存でないコードと混在させると、不一致が生じてコンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、関数プロトタイプの規則 を参照してください。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)
各言語での呼び出し定義
// msi.dll (ANSI / -A)
#include <windows.h>
DWORD MsiEnumProductsExA(
LPCSTR szProductCode, // optional
LPCSTR szUserSid, // optional
DWORD dwContext,
DWORD dwIndex,
LPSTR szInstalledProductCode, // optional
MSIINSTALLCONTEXT* pdwInstalledContext, // optional
LPSTR szSid, // optional
DWORD* pcchSid // optional
);[DllImport("msi.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint MsiEnumProductsExA(
[MarshalAs(UnmanagedType.LPStr)] string szProductCode, // LPCSTR optional
[MarshalAs(UnmanagedType.LPStr)] string szUserSid, // LPCSTR optional
uint dwContext, // DWORD
uint dwIndex, // DWORD
[MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder szInstalledProductCode, // 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 MsiEnumProductsExA(
<MarshalAs(UnmanagedType.LPStr)> szProductCode As String, ' LPCSTR optional
<MarshalAs(UnmanagedType.LPStr)> szUserSid As String, ' LPCSTR optional
dwContext As UInteger, ' DWORD
dwIndex As UInteger, ' DWORD
<MarshalAs(UnmanagedType.LPStr)> szInstalledProductCode 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' szProductCode : LPCSTR optional
' szUserSid : LPCSTR optional
' dwContext : DWORD
' dwIndex : DWORD
' szInstalledProductCode : LPSTR optional, out
' pdwInstalledContext : MSIINSTALLCONTEXT* optional, out
' szSid : LPSTR optional, out
' pcchSid : DWORD* optional, in/out
Declare PtrSafe Function MsiEnumProductsExA Lib "msi" ( _
ByVal szProductCode As String, _
ByVal szUserSid As String, _
ByVal dwContext As Long, _
ByVal dwIndex As Long, _
ByVal szInstalledProductCode 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
MsiEnumProductsExA = ctypes.windll.msi.MsiEnumProductsExA
MsiEnumProductsExA.restype = wintypes.DWORD
MsiEnumProductsExA.argtypes = [
wintypes.LPCSTR, # szProductCode : LPCSTR optional
wintypes.LPCSTR, # szUserSid : LPCSTR optional
wintypes.DWORD, # dwContext : DWORD
wintypes.DWORD, # dwIndex : DWORD
wintypes.LPSTR, # szInstalledProductCode : 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')
MsiEnumProductsExA = Fiddle::Function.new(
lib['MsiEnumProductsExA'],
[
Fiddle::TYPE_VOIDP, # szProductCode : LPCSTR optional
Fiddle::TYPE_VOIDP, # szUserSid : LPCSTR optional
-Fiddle::TYPE_INT, # dwContext : DWORD
-Fiddle::TYPE_INT, # dwIndex : DWORD
Fiddle::TYPE_VOIDP, # szInstalledProductCode : 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 MsiEnumProductsExA(
szProductCode: *const u8, // LPCSTR optional
szUserSid: *const u8, // LPCSTR optional
dwContext: u32, // DWORD
dwIndex: u32, // DWORD
szInstalledProductCode: *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 MsiEnumProductsExA([MarshalAs(UnmanagedType.LPStr)] string szProductCode, [MarshalAs(UnmanagedType.LPStr)] string szUserSid, uint dwContext, uint dwIndex, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder szInstalledProductCode, IntPtr pdwInstalledContext, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder szSid, IntPtr pcchSid);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiEnumProductsExA' -Namespace Win32 -PassThru
# $api::MsiEnumProductsExA(szProductCode, szUserSid, dwContext, dwIndex, szInstalledProductCode, pdwInstalledContext, szSid, pcchSid)#uselib "msi.dll"
#func global MsiEnumProductsExA "MsiEnumProductsExA" sptr, sptr, sptr, sptr, sptr, sptr, sptr, sptr
; MsiEnumProductsExA szProductCode, szUserSid, dwContext, dwIndex, varptr(szInstalledProductCode), varptr(pdwInstalledContext), varptr(szSid), varptr(pcchSid) ; 戻り値は stat
; szProductCode : LPCSTR optional -> "sptr"
; szUserSid : LPCSTR optional -> "sptr"
; dwContext : DWORD -> "sptr"
; dwIndex : DWORD -> "sptr"
; szInstalledProductCode : 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 MsiEnumProductsExA "MsiEnumProductsExA" str, str, int, int, var, var, var, var ; res = MsiEnumProductsExA(szProductCode, szUserSid, dwContext, dwIndex, szInstalledProductCode, pdwInstalledContext, szSid, pcchSid) ; szProductCode : LPCSTR optional -> "str" ; szUserSid : LPCSTR optional -> "str" ; dwContext : DWORD -> "int" ; dwIndex : DWORD -> "int" ; szInstalledProductCode : LPSTR optional, out -> "var" ; pdwInstalledContext : MSIINSTALLCONTEXT* optional, out -> "var" ; szSid : LPSTR optional, out -> "var" ; pcchSid : DWORD* optional, in/out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "msi.dll" #cfunc global MsiEnumProductsExA "MsiEnumProductsExA" str, str, int, int, sptr, sptr, sptr, sptr ; res = MsiEnumProductsExA(szProductCode, szUserSid, dwContext, dwIndex, varptr(szInstalledProductCode), varptr(pdwInstalledContext), varptr(szSid), varptr(pcchSid)) ; szProductCode : LPCSTR optional -> "str" ; szUserSid : LPCSTR optional -> "str" ; dwContext : DWORD -> "int" ; dwIndex : DWORD -> "int" ; szInstalledProductCode : LPSTR optional, out -> "sptr" ; pdwInstalledContext : MSIINSTALLCONTEXT* optional, out -> "sptr" ; szSid : LPSTR optional, out -> "sptr" ; pcchSid : DWORD* optional, in/out -> "sptr" ; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。
; DWORD MsiEnumProductsExA(LPCSTR szProductCode, LPCSTR szUserSid, DWORD dwContext, DWORD dwIndex, LPSTR szInstalledProductCode, MSIINSTALLCONTEXT* pdwInstalledContext, LPSTR szSid, DWORD* pcchSid) #uselib "msi.dll" #cfunc global MsiEnumProductsExA "MsiEnumProductsExA" str, str, int, int, var, var, var, var ; res = MsiEnumProductsExA(szProductCode, szUserSid, dwContext, dwIndex, szInstalledProductCode, pdwInstalledContext, szSid, pcchSid) ; szProductCode : LPCSTR optional -> "str" ; szUserSid : LPCSTR optional -> "str" ; dwContext : DWORD -> "int" ; dwIndex : DWORD -> "int" ; szInstalledProductCode : LPSTR optional, out -> "var" ; pdwInstalledContext : MSIINSTALLCONTEXT* optional, out -> "var" ; szSid : LPSTR optional, out -> "var" ; pcchSid : DWORD* optional, in/out -> "var" ; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。; DWORD MsiEnumProductsExA(LPCSTR szProductCode, LPCSTR szUserSid, DWORD dwContext, DWORD dwIndex, LPSTR szInstalledProductCode, MSIINSTALLCONTEXT* pdwInstalledContext, LPSTR szSid, DWORD* pcchSid) #uselib "msi.dll" #cfunc global MsiEnumProductsExA "MsiEnumProductsExA" str, str, int, int, intptr, intptr, intptr, intptr ; res = MsiEnumProductsExA(szProductCode, szUserSid, dwContext, dwIndex, varptr(szInstalledProductCode), varptr(pdwInstalledContext), varptr(szSid), varptr(pcchSid)) ; szProductCode : LPCSTR optional -> "str" ; szUserSid : LPCSTR optional -> "str" ; dwContext : DWORD -> "int" ; dwIndex : DWORD -> "int" ; szInstalledProductCode : LPSTR optional, out -> "intptr" ; pdwInstalledContext : MSIINSTALLCONTEXT* optional, out -> "intptr" ; 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")
procMsiEnumProductsExA = msi.NewProc("MsiEnumProductsExA")
)
// szProductCode (LPCSTR optional), szUserSid (LPCSTR optional), dwContext (DWORD), dwIndex (DWORD), szInstalledProductCode (LPSTR optional, out), pdwInstalledContext (MSIINSTALLCONTEXT* optional, out), szSid (LPSTR optional, out), pcchSid (DWORD* optional, in/out)
r1, _, err := procMsiEnumProductsExA.Call(
uintptr(unsafe.Pointer(windows.BytePtrFromString(szProductCode))),
uintptr(unsafe.Pointer(windows.BytePtrFromString(szUserSid))),
uintptr(dwContext),
uintptr(dwIndex),
uintptr(szInstalledProductCode),
uintptr(pdwInstalledContext),
uintptr(szSid),
uintptr(pcchSid),
)
_ = err // syscall.Errno (valid when the call sets last-error)
_ = r1 // DWORDfunction MsiEnumProductsExA(
szProductCode: PAnsiChar; // LPCSTR optional
szUserSid: PAnsiChar; // LPCSTR optional
dwContext: DWORD; // DWORD
dwIndex: DWORD; // DWORD
szInstalledProductCode: 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 'MsiEnumProductsExA';result := DllCall("msi\MsiEnumProductsExA"
, "AStr", szProductCode ; LPCSTR optional
, "AStr", szUserSid ; LPCSTR optional
, "UInt", dwContext ; DWORD
, "UInt", dwIndex ; DWORD
, "Ptr", szInstalledProductCode ; LPSTR optional, out
, "Ptr", pdwInstalledContext ; MSIINSTALLCONTEXT* optional, out
, "Ptr", szSid ; LPSTR optional, out
, "Ptr", pcchSid ; DWORD* optional, in/out
, "UInt") ; return: DWORD●MsiEnumProductsExA(szProductCode, szUserSid, dwContext, dwIndex, szInstalledProductCode, pdwInstalledContext, szSid, pcchSid) = DLL("msi.dll", "dword MsiEnumProductsExA(char*, char*, dword, dword, char*, void*, char*, void*)")
# 呼び出し: MsiEnumProductsExA(szProductCode, szUserSid, dwContext, dwIndex, szInstalledProductCode, pdwInstalledContext, szSid, pcchSid)
# szProductCode : LPCSTR optional -> "char*"
# szUserSid : LPCSTR optional -> "char*"
# dwContext : DWORD -> "dword"
# dwIndex : DWORD -> "dword"
# szInstalledProductCode : 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 MsiEnumProductsExA(
szProductCode: [*c]const u8, // LPCSTR optional
szUserSid: [*c]const u8, // LPCSTR optional
dwContext: u32, // DWORD
dwIndex: u32, // DWORD
szInstalledProductCode: [*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 MsiEnumProductsExA(
szProductCode: cstring, # LPCSTR optional
szUserSid: cstring, # LPCSTR optional
dwContext: uint32, # DWORD
dwIndex: uint32, # DWORD
szInstalledProductCode: 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: "MsiEnumProductsExA", stdcall, dynlib: "msi.dll".}pragma(lib, "msi");
extern(Windows)
uint MsiEnumProductsExA(
const(char)* szProductCode, // LPCSTR optional
const(char)* szUserSid, // LPCSTR optional
uint dwContext, // DWORD
uint dwIndex, // DWORD
char* szInstalledProductCode, // LPSTR optional, out
int* pdwInstalledContext, // MSIINSTALLCONTEXT* optional, out
char* szSid, // LPSTR optional, out
uint* pcchSid // DWORD* optional, in/out
);ccall((:MsiEnumProductsExA, "msi.dll"), stdcall, UInt32,
(Cstring, Cstring, UInt32, UInt32, Ptr{UInt8}, Ptr{Int32}, Ptr{UInt8}, Ptr{UInt32}),
szProductCode, szUserSid, dwContext, dwIndex, szInstalledProductCode, pdwInstalledContext, szSid, pcchSid)
# szProductCode : LPCSTR optional -> Cstring
# szUserSid : LPCSTR optional -> Cstring
# dwContext : DWORD -> UInt32
# dwIndex : DWORD -> UInt32
# szInstalledProductCode : 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 MsiEnumProductsExA(
const char* szProductCode,
const char* szUserSid,
uint32_t dwContext,
uint32_t dwIndex,
char* szInstalledProductCode,
int32_t* pdwInstalledContext,
char* szSid,
uint32_t* pcchSid);
]]
local msi = ffi.load("msi")
-- msi.MsiEnumProductsExA(szProductCode, szUserSid, dwContext, dwIndex, szInstalledProductCode, pdwInstalledContext, szSid, pcchSid)
-- szProductCode : LPCSTR optional
-- szUserSid : LPCSTR optional
-- dwContext : DWORD
-- dwIndex : DWORD
-- szInstalledProductCode : 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 MsiEnumProductsExA = lib.func('__stdcall', 'MsiEnumProductsExA', 'uint32_t', ['str', 'str', 'uint32_t', 'uint32_t', 'char *', 'int32_t *', 'char *', 'uint32_t *']);
// MsiEnumProductsExA(szProductCode, szUserSid, dwContext, dwIndex, szInstalledProductCode, pdwInstalledContext, szSid, pcchSid)
// szProductCode : LPCSTR optional -> 'str'
// szUserSid : LPCSTR optional -> 'str'
// dwContext : DWORD -> 'uint32_t'
// dwIndex : DWORD -> 'uint32_t'
// szInstalledProductCode : 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", {
MsiEnumProductsExA: { parameters: ["buffer", "buffer", "u32", "u32", "buffer", "pointer", "buffer", "pointer"], result: "u32" },
});
// lib.symbols.MsiEnumProductsExA(szProductCode, szUserSid, dwContext, dwIndex, szInstalledProductCode, pdwInstalledContext, szSid, pcchSid)
// szProductCode : LPCSTR optional -> "buffer"
// szUserSid : LPCSTR optional -> "buffer"
// dwContext : DWORD -> "u32"
// dwIndex : DWORD -> "u32"
// szInstalledProductCode : 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 MsiEnumProductsExA(
const char* szProductCode,
const char* szUserSid,
uint32_t dwContext,
uint32_t dwIndex,
char* szInstalledProductCode,
int32_t* pdwInstalledContext,
char* szSid,
uint32_t* pcchSid);
C, "msi.dll");
// $ffi->MsiEnumProductsExA(szProductCode, szUserSid, dwContext, dwIndex, szInstalledProductCode, pdwInstalledContext, szSid, pcchSid);
// szProductCode : LPCSTR optional
// szUserSid : LPCSTR optional
// dwContext : DWORD
// dwIndex : DWORD
// szInstalledProductCode : 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 MsiEnumProductsExA(
String szProductCode, // LPCSTR optional
String szUserSid, // LPCSTR optional
int dwContext, // DWORD
int dwIndex, // DWORD
byte[] szInstalledProductCode, // LPSTR optional, out
IntByReference pdwInstalledContext, // MSIINSTALLCONTEXT* optional, out
byte[] szSid, // LPSTR optional, out
IntByReference pcchSid // DWORD* optional, in/out
);
}@[Link("msi")]
lib Libmsi
fun MsiEnumProductsExA = MsiEnumProductsExA(
szProductCode : UInt8*, # LPCSTR optional
szUserSid : UInt8*, # LPCSTR optional
dwContext : UInt32, # DWORD
dwIndex : UInt32, # DWORD
szInstalledProductCode : 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 MsiEnumProductsExANative = Uint32 Function(Pointer<Utf8>, Pointer<Utf8>, Uint32, Uint32, Pointer<Utf8>, Pointer<Int32>, Pointer<Utf8>, Pointer<Uint32>);
typedef MsiEnumProductsExADart = int Function(Pointer<Utf8>, Pointer<Utf8>, int, int, Pointer<Utf8>, Pointer<Int32>, Pointer<Utf8>, Pointer<Uint32>);
final MsiEnumProductsExA = DynamicLibrary.open('msi.dll')
.lookupFunction<MsiEnumProductsExANative, MsiEnumProductsExADart>('MsiEnumProductsExA');
// szProductCode : LPCSTR optional -> Pointer<Utf8>
// szUserSid : LPCSTR optional -> Pointer<Utf8>
// dwContext : DWORD -> Uint32
// dwIndex : DWORD -> Uint32
// szInstalledProductCode : 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 MsiEnumProductsExA(
szProductCode: PAnsiChar; // LPCSTR optional
szUserSid: PAnsiChar; // LPCSTR optional
dwContext: DWORD; // DWORD
dwIndex: DWORD; // DWORD
szInstalledProductCode: 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 'MsiEnumProductsExA';import Foreign
import Foreign.C.Types
import Foreign.C.String
foreign import stdcall safe "MsiEnumProductsExA"
c_MsiEnumProductsExA :: CString -> CString -> Word32 -> Word32 -> CString -> Ptr Int32 -> CString -> Ptr Word32 -> IO Word32
-- szProductCode : LPCSTR optional -> CString
-- szUserSid : LPCSTR optional -> CString
-- dwContext : DWORD -> Word32
-- dwIndex : DWORD -> Word32
-- szInstalledProductCode : 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 msienumproductsexa =
foreign "MsiEnumProductsExA"
(string @-> string @-> uint32_t @-> uint32_t @-> string @-> (ptr int32_t) @-> string @-> (ptr uint32_t) @-> returning uint32_t)
(* szProductCode : LPCSTR optional -> string *)
(* szUserSid : LPCSTR optional -> string *)
(* dwContext : DWORD -> uint32_t *)
(* dwIndex : DWORD -> uint32_t *)
(* szInstalledProductCode : 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 ("MsiEnumProductsExA" msi-enum-products-ex-a :convention :stdcall) :uint32
(sz-product-code :string) ; LPCSTR optional
(sz-user-sid :string) ; LPCSTR optional
(dw-context :uint32) ; DWORD
(dw-index :uint32) ; DWORD
(sz-installed-product-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 $MsiEnumProductsExA = Win32::API::More->new('msi',
'DWORD MsiEnumProductsExA(LPCSTR szProductCode, LPCSTR szUserSid, DWORD dwContext, DWORD dwIndex, LPSTR szInstalledProductCode, LPVOID pdwInstalledContext, LPSTR szSid, LPVOID pcchSid)');
# my $ret = $MsiEnumProductsExA->Call($szProductCode, $szUserSid, $dwContext, $dwIndex, $szInstalledProductCode, $pdwInstalledContext, $szSid, $pcchSid);
# szProductCode : LPCSTR optional -> LPCSTR
# szUserSid : LPCSTR optional -> LPCSTR
# dwContext : DWORD -> DWORD
# dwIndex : DWORD -> DWORD
# szInstalledProductCode : LPSTR optional, out -> LPSTR
# pdwInstalledContext : MSIINSTALLCONTEXT* optional, out -> LPVOID
# szSid : LPSTR optional, out -> LPSTR
# pcchSid : DWORD* optional, in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。関連項目
- f MsiEnumProductsExW (Unicode版) — コンテキストやユーザーを指定してインストール済み製品を列挙する。
- f MsiEnumProductsA — インストール済みの製品をインデックス順に列挙して製品コードを取得する。