ホーム › System.ApplicationInstallationAndServicing › MsiEnumComponentsA

MsiEnumComponentsA

関数

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

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

シグネチャ

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

DWORD MsiEnumComponentsA(
    DWORD iComponentIndex,
    LPSTR lpComponentBuf
);

パラメーター

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

戻り値の型: DWORD

公式ドキュメント

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

戻り値

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

解説(Remarks)

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

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

メモ

msi.h ヘッダーは MsiEnumComponents を、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 MsiEnumComponentsA(
    DWORD iComponentIndex,
    LPSTR lpComponentBuf
);

[DllImport("msi.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint MsiEnumComponentsA(
    uint iComponentIndex,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpComponentBuf   // LPSTR out
);

<DllImport("msi.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function MsiEnumComponentsA(
    iComponentIndex As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> lpComponentBuf As System.Text.StringBuilder   ' LPSTR out
) As UInteger
End Function

' iComponentIndex : DWORD
' lpComponentBuf : LPSTR out
Declare PtrSafe Function MsiEnumComponentsA Lib "msi" ( _
    ByVal iComponentIndex As Long, _
    ByVal lpComponentBuf As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

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

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiEnumComponentsA = Fiddle::Function.new(
  lib['MsiEnumComponentsA'],
  [
    -Fiddle::TYPE_INT,  # iComponentIndex : DWORD
    Fiddle::TYPE_VOIDP,  # lpComponentBuf : LPSTR out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "msi")]
extern "system" {
    fn MsiEnumComponentsA(
        iComponentIndex: u32,  // DWORD
        lpComponentBuf: *mut u8  // LPSTR out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("msi.dll", CharSet = CharSet.Ansi)]
public static extern uint MsiEnumComponentsA(uint iComponentIndex, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpComponentBuf);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiEnumComponentsA' -Namespace Win32 -PassThru
# $api::MsiEnumComponentsA(iComponentIndex, lpComponentBuf)

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

出力引数:

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