ホーム › System.ApplicationInstallationAndServicing › MsiEnumComponentsW

MsiEnumComponentsW

関数

システムに登録されたコンポーネントをインデックス順に列挙する。

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

シグネチャ

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

DWORD MsiEnumComponentsW(
    DWORD iComponentIndex,
    LPWSTR lpComponentBuf
);

パラメーター

名前	型	方向	説明
iComponentIndex	DWORD	in	取得するコンポーネントのインデックスを指定します。このパラメーターは、 MsiEnumComponents 関数の最初の呼び出しではゼロを指定し、以降の呼び出しでは増分する必要があります。コンポーネントには順序がないため、新しいコンポーネントには任意のインデックスが割り当てられます。つまり、この関数はコンポーネントを任意の順序で返す可能性があります。
lpComponentBuf	LPWSTR	out	コンポーネントコードを受け取るバッファーへのポインター。このバッファーは 39 文字分の長さが必要です。最初の 38 文字は GUID 用で、最後の 1 文字は終端の null 文字用です。

戻り値の型: DWORD

公式ドキュメント

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

戻り値

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

解説(Remarks)

コンポーネントを列挙するには、アプリケーションはまず iComponentIndex パラメーターをゼロに設定して MsiEnumComponents 関数を呼び出します。続いて、アプリケーションは iComponentIndex パラメーターを増分しながら、コンポーネントがなくなるまで(つまり、関数が ERROR_NO_MORE_ITEMS を返すまで) MsiEnumComponents を呼び出します。

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

メモ

msi.h ヘッダーは、MsiEnumComponents を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義しています。エンコーディング非依存のエイリアスと、エンコーディング非依存でないコードを混在させて使用すると、不一致が生じてコンパイルエラーや実行時エラーの原因となる可能性があります。詳細については、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 MsiEnumComponentsW(
    DWORD iComponentIndex,
    LPWSTR lpComponentBuf
);

[DllImport("msi.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint MsiEnumComponentsW(
    uint iComponentIndex,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpComponentBuf   // LPWSTR out
);

<DllImport("msi.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function MsiEnumComponentsW(
    iComponentIndex As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> lpComponentBuf As System.Text.StringBuilder   ' LPWSTR out
) As UInteger
End Function

' iComponentIndex : DWORD
' lpComponentBuf : LPWSTR out
Declare PtrSafe Function MsiEnumComponentsW Lib "msi" ( _
    ByVal iComponentIndex As Long, _
    ByVal lpComponentBuf 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

MsiEnumComponentsW = ctypes.windll.msi.MsiEnumComponentsW
MsiEnumComponentsW.restype = wintypes.DWORD
MsiEnumComponentsW.argtypes = [
    wintypes.DWORD,  # iComponentIndex : DWORD
    wintypes.LPWSTR,  # lpComponentBuf : LPWSTR out
]

require 'fiddle'
require 'fiddle/import'

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

#[link(name = "msi")]
extern "system" {
    fn MsiEnumComponentsW(
        iComponentIndex: u32,  // DWORD
        lpComponentBuf: *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 MsiEnumComponentsW(uint iComponentIndex, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpComponentBuf);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiEnumComponentsW' -Namespace Win32 -PassThru
# $api::MsiEnumComponentsW(iComponentIndex, lpComponentBuf)

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

出力引数:

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