ホーム › System.ApplicationInstallationAndServicing › MsiEnumFeaturesA

MsiEnumFeaturesA

関数

指定製品の公開フィーチャーをインデックス順に列挙し親も取得する。

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

シグネチャ

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

DWORD MsiEnumFeaturesA(
    LPCSTR szProduct,
    DWORD iFeatureIndex,
    LPSTR lpFeatureBuf,
    LPSTR lpParentBuf   // optional
);

パラメーター

名前	型	方向	説明
szProduct	LPCSTR	in	機能を列挙する対象製品の製品コードを指定する、null 終端文字列です。
iFeatureIndex	DWORD	in	取得する機能のインデックスを指定します。このパラメーターは、 MsiEnumFeatures 関数の最初の呼び出しではゼロにし、その後の呼び出しごとにインクリメントしてください。機能には順序がないため、新しい機能には任意のインデックスが割り当てられます。つまり、この関数は任意の順序で機能を返す可能性があります。
lpFeatureBuf	LPSTR	out	機能 ID を受け取るバッファーへのポインターです。バッファーのサイズは、長さ MAX_FEATURE_CHARS+1 の文字列値を格納できる必要があります。機能 ID の長さが MAX_FEATURE_CHARS を超える場合、この関数は ERROR_MORE_DATA を返します。
lpParentBuf	LPSTR	outoptional	その機能の親機能の機能 ID を受け取るバッファーへのポインターです。バッファーのサイズは、長さ MAX_FEATURE_CHARS+1 の文字列値を格納できる必要があります。親機能の機能 ID の長さが MAX_FEATURE_CHARS を超える場合は、先頭の MAX_FEATURE_CHARS 文字のみがバッファーにコピーされます。

戻り値の型: DWORD

公式ドキュメント

MsiEnumFeatures 関数は、指定された製品について公開されている機能を列挙します。この関数は、呼び出されるたびに 1 つの機能 ID を取得します。(ANSI)

戻り値

値	意味
ERROR_BAD_CONFIGURATION	構成データが破損しています。
ERROR_INVALID_PARAMETER	無効なパラメーターが関数に渡されました。
ERROR_MORE_DATA	バッファーが小さすぎて、要求されたデータを格納できません。
ERROR_NO_MORE_ITEMS	返す機能がありません。
ERROR_SUCCESS	値が列挙されました。
ERROR_UNKNOWN_PRODUCT	指定された製品は不明です。

解説(Remarks)

機能を列挙するには、アプリケーションはまず iFeatureIndex パラメーターをゼロに設定して MsiEnumFeatures 関数を呼び出します。その後、アプリケーションは iFeatureIndex パラメーターをインクリメントし、機能がなくなるまで(つまり、関数が ERROR_NO_MORE_ITEMS を返すまで) MsiEnumFeatures を呼び出してください。

メモ

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

[DllImport("msi.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint MsiEnumFeaturesA(
    [MarshalAs(UnmanagedType.LPStr)] string szProduct,   // LPCSTR
    uint iFeatureIndex,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpFeatureBuf,   // LPSTR out
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpParentBuf   // LPSTR optional, out
);

<DllImport("msi.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function MsiEnumFeaturesA(
    <MarshalAs(UnmanagedType.LPStr)> szProduct As String,   ' LPCSTR
    iFeatureIndex As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> lpFeatureBuf As System.Text.StringBuilder,   ' LPSTR out
    <MarshalAs(UnmanagedType.LPStr)> lpParentBuf As System.Text.StringBuilder   ' LPSTR optional, out
) As UInteger
End Function

' szProduct : LPCSTR
' iFeatureIndex : DWORD
' lpFeatureBuf : LPSTR out
' lpParentBuf : LPSTR optional, out
Declare PtrSafe Function MsiEnumFeaturesA Lib "msi" ( _
    ByVal szProduct As String, _
    ByVal iFeatureIndex As Long, _
    ByVal lpFeatureBuf As String, _
    ByVal lpParentBuf As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

MsiEnumFeaturesA = ctypes.windll.msi.MsiEnumFeaturesA
MsiEnumFeaturesA.restype = wintypes.DWORD
MsiEnumFeaturesA.argtypes = [
    wintypes.LPCSTR,  # szProduct : LPCSTR
    wintypes.DWORD,  # iFeatureIndex : DWORD
    wintypes.LPSTR,  # lpFeatureBuf : LPSTR out
    wintypes.LPSTR,  # lpParentBuf : LPSTR optional, out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiEnumFeaturesA = Fiddle::Function.new(
  lib['MsiEnumFeaturesA'],
  [
    Fiddle::TYPE_VOIDP,  # szProduct : LPCSTR
    -Fiddle::TYPE_INT,  # iFeatureIndex : DWORD
    Fiddle::TYPE_VOIDP,  # lpFeatureBuf : LPSTR out
    Fiddle::TYPE_VOIDP,  # lpParentBuf : LPSTR optional, out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "msi")]
extern "system" {
    fn MsiEnumFeaturesA(
        szProduct: *const u8,  // LPCSTR
        iFeatureIndex: u32,  // DWORD
        lpFeatureBuf: *mut u8,  // LPSTR out
        lpParentBuf: *mut u8  // LPSTR optional, out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("msi.dll", CharSet = CharSet.Ansi)]
public static extern uint MsiEnumFeaturesA([MarshalAs(UnmanagedType.LPStr)] string szProduct, uint iFeatureIndex, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpFeatureBuf, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpParentBuf);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiEnumFeaturesA' -Namespace Win32 -PassThru
# $api::MsiEnumFeaturesA(szProduct, iFeatureIndex, lpFeatureBuf, lpParentBuf)

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

出力引数:

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