ホーム › System.ApplicationInstallationAndServicing › MsiEnumClientsW

MsiEnumClientsW

関数

指定コンポーネントを使用するクライアント製品を列挙する。

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

シグネチャ

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

DWORD MsiEnumClientsW(
    LPCWSTR szComponent,
    DWORD iProductIndex,
    LPWSTR lpProductBuf
);

パラメーター

名前	型	方向	説明
szComponent	LPCWSTR	in	クライアントを列挙する対象のコンポーネントを指定します。
iProductIndex	DWORD	in	取得するクライアントのインデックスを指定します。このパラメーターは、 MsiEnumClients 関数の最初の呼び出しでは 0 とし、以降の呼び出しでは増分してください。クライアントには順序がないため、新しいクライアントには任意のインデックスが割り当てられます。つまり、この関数はクライアントを任意の順序で返す可能性があります。
lpProductBuf	LPWSTR	out	製品コードを受け取るバッファーへのポインター。このバッファーの長さは 39 文字でなければなりません。先頭 38 文字は GUID 用、最後の 1 文字は終端の null 文字用です。

戻り値の型: DWORD

公式ドキュメント

MsiEnumClients 関数は、指定されたインストール済みコンポーネントのクライアントを列挙します。この関数は、呼び出されるたびに 1 つの製品コードを取得します。(Unicode)

戻り値

値	意味
ERROR_BAD_CONFIGURATION	構成データが破損しています。
ERROR_INVALID_PARAMETER	無効なパラメーターが関数に渡されました。
ERROR_NO_MORE_ITEMS	返すクライアントがありません。
ERROR_NOT_ENOUGH_MEMORY	操作を完了するのに十分なメモリがシステムにありません。Windows Server 2003 以降で使用できます。
ERROR_SUCCESS	値が列挙されました。
ERROR_UNKNOWN_COMPONENT	指定されたコンポーネントが不明です。

解説(Remarks)

クライアントを列挙するには、アプリケーションはまず iProductIndex パラメーターを 0 に設定して MsiEnumClients 関数を呼び出す必要があります。その後、アプリケーションは iProductIndex パラメーターを増分しながら、クライアントがなくなるまで(つまり、関数が ERROR_NO_MORE_ITEMS を返すまで) MsiEnumClients を呼び出します。

コンポーネントのすべてのクライアントを列挙するために MsiEnumClients を複数回呼び出す場合は、各呼び出しを同一のスレッドから行う必要があります。

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

DWORD MsiEnumClientsW(
    LPCWSTR szComponent,
    DWORD iProductIndex,
    LPWSTR lpProductBuf
);

[DllImport("msi.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint MsiEnumClientsW(
    [MarshalAs(UnmanagedType.LPWStr)] string szComponent,   // LPCWSTR
    uint iProductIndex,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpProductBuf   // LPWSTR out
);

<DllImport("msi.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function MsiEnumClientsW(
    <MarshalAs(UnmanagedType.LPWStr)> szComponent As String,   ' LPCWSTR
    iProductIndex As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> lpProductBuf As System.Text.StringBuilder   ' LPWSTR out
) As UInteger
End Function

' szComponent : LPCWSTR
' iProductIndex : DWORD
' lpProductBuf : LPWSTR out
Declare PtrSafe Function MsiEnumClientsW Lib "msi" ( _
    ByVal szComponent As LongPtr, _
    ByVal iProductIndex As Long, _
    ByVal lpProductBuf 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

MsiEnumClientsW = ctypes.windll.msi.MsiEnumClientsW
MsiEnumClientsW.restype = wintypes.DWORD
MsiEnumClientsW.argtypes = [
    wintypes.LPCWSTR,  # szComponent : LPCWSTR
    wintypes.DWORD,  # iProductIndex : DWORD
    wintypes.LPWSTR,  # lpProductBuf : LPWSTR out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiEnumClientsW = Fiddle::Function.new(
  lib['MsiEnumClientsW'],
  [
    Fiddle::TYPE_VOIDP,  # szComponent : LPCWSTR
    -Fiddle::TYPE_INT,  # iProductIndex : DWORD
    Fiddle::TYPE_VOIDP,  # lpProductBuf : LPWSTR out
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "msi")]
extern "system" {
    fn MsiEnumClientsW(
        szComponent: *const u16,  // LPCWSTR
        iProductIndex: u32,  // DWORD
        lpProductBuf: *mut u16  // LPWSTR out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("msi.dll", CharSet = CharSet.Unicode)]
public static extern uint MsiEnumClientsW([MarshalAs(UnmanagedType.LPWStr)] string szComponent, uint iProductIndex, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpProductBuf);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiEnumClientsW' -Namespace Win32 -PassThru
# $api::MsiEnumClientsW(szComponent, iProductIndex, lpProductBuf)

#uselib "msi.dll"
#func global MsiEnumClientsW "MsiEnumClientsW" wptr, wptr, wptr
; MsiEnumClientsW szComponent, iProductIndex, varptr(lpProductBuf)   ; 戻り値は stat
; szComponent : LPCWSTR -> "wptr"
; iProductIndex : DWORD -> "wptr"
; lpProductBuf : LPWSTR out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "msi.dll"
#cfunc global MsiEnumClientsW "MsiEnumClientsW" wstr, int, var
; res = MsiEnumClientsW(szComponent, iProductIndex, lpProductBuf)
; szComponent : LPCWSTR -> "wstr"
; iProductIndex : DWORD -> "int"
; lpProductBuf : LPWSTR out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "msi.dll"
#cfunc global MsiEnumClientsW "MsiEnumClientsW" wstr, int, sptr
; res = MsiEnumClientsW(szComponent, iProductIndex, varptr(lpProductBuf))
; szComponent : LPCWSTR -> "wstr"
; iProductIndex : DWORD -> "int"
; lpProductBuf : LPWSTR out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。