Win32 API 日本語リファレンス
ホームSystem.ApplicationInstallationAndServicing › MsiEnumFeaturesW

MsiEnumFeaturesW

関数
指定製品の公開フィーチャーをインデックス順に列挙し親も取得する。
DLLmsi.dll文字セットUnicode (-W)呼出規約winapi対応OSwindows8.0

シグネチャ

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

DWORD MsiEnumFeaturesW(
    LPCWSTR szProduct,
    DWORD iFeatureIndex,
    LPWSTR lpFeatureBuf,
    LPWSTR lpParentBuf   // optional
);

パラメーター

名前方向説明
szProductLPCWSTRin機能を列挙する対象製品の製品コードを指定する、null 終端文字列です。
iFeatureIndexDWORDin取得する機能のインデックスを指定します。このパラメーターは、 MsiEnumFeatures 関数の最初の呼び出しではゼロにし、以降の呼び出しでは増分します。機能には順序がないため、新しい機能は任意のインデックスを持ちます。つまり、この関数は任意の順序で機能を返す可能性があります。
lpFeatureBufLPWSTRout機能 ID を受け取るバッファーへのポインターです。バッファーのサイズは、長さ MAX_FEATURE_CHARS+1 の文字列値を格納できる必要があります。機能 ID の長さが MAX_FEATURE_CHARS を超える場合、この関数は ERROR_MORE_DATA を返します。
lpParentBufLPWSTRoutoptionalその機能の親機能の機能 ID を受け取るバッファーへのポインターです。バッファーのサイズは、長さ MAX_FEATURE_CHARS+1 の文字列値を格納できる必要があります。親機能の機能 ID の長さが MAX_FEATURE_CHARS を超える場合は、先頭の MAX_FEATURE_CHARS 文字だけがバッファーにコピーされます。

戻り値の型: DWORD

公式ドキュメント

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

戻り値

意味
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  (Unicode / -W)
#include <windows.h>

DWORD MsiEnumFeaturesW(
    LPCWSTR szProduct,
    DWORD iFeatureIndex,
    LPWSTR lpFeatureBuf,
    LPWSTR lpParentBuf   // optional
);
[DllImport("msi.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint MsiEnumFeaturesW(
    [MarshalAs(UnmanagedType.LPWStr)] string szProduct,   // LPCWSTR
    uint iFeatureIndex,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpFeatureBuf,   // LPWSTR out
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpParentBuf   // LPWSTR optional, out
);
<DllImport("msi.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function MsiEnumFeaturesW(
    <MarshalAs(UnmanagedType.LPWStr)> szProduct As String,   ' LPCWSTR
    iFeatureIndex As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> lpFeatureBuf As System.Text.StringBuilder,   ' LPWSTR out
    <MarshalAs(UnmanagedType.LPWStr)> lpParentBuf As System.Text.StringBuilder   ' LPWSTR optional, out
) As UInteger
End Function
' szProduct : LPCWSTR
' iFeatureIndex : DWORD
' lpFeatureBuf : LPWSTR out
' lpParentBuf : LPWSTR optional, out
Declare PtrSafe Function MsiEnumFeaturesW Lib "msi" ( _
    ByVal szProduct As LongPtr, _
    ByVal iFeatureIndex As Long, _
    ByVal lpFeatureBuf As LongPtr, _
    ByVal lpParentBuf 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

MsiEnumFeaturesW = ctypes.windll.msi.MsiEnumFeaturesW
MsiEnumFeaturesW.restype = wintypes.DWORD
MsiEnumFeaturesW.argtypes = [
    wintypes.LPCWSTR,  # szProduct : LPCWSTR
    wintypes.DWORD,  # iFeatureIndex : DWORD
    wintypes.LPWSTR,  # lpFeatureBuf : LPWSTR out
    wintypes.LPWSTR,  # lpParentBuf : LPWSTR optional, out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiEnumFeaturesW = Fiddle::Function.new(
  lib['MsiEnumFeaturesW'],
  [
    Fiddle::TYPE_VOIDP,  # szProduct : LPCWSTR
    -Fiddle::TYPE_INT,  # iFeatureIndex : DWORD
    Fiddle::TYPE_VOIDP,  # lpFeatureBuf : LPWSTR out
    Fiddle::TYPE_VOIDP,  # lpParentBuf : LPWSTR optional, out
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"
#[link(name = "msi")]
extern "system" {
    fn MsiEnumFeaturesW(
        szProduct: *const u16,  // LPCWSTR
        iFeatureIndex: u32,  // DWORD
        lpFeatureBuf: *mut u16,  // LPWSTR out
        lpParentBuf: *mut u16  // LPWSTR optional, out
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("msi.dll", CharSet = CharSet.Unicode)]
public static extern uint MsiEnumFeaturesW([MarshalAs(UnmanagedType.LPWStr)] string szProduct, uint iFeatureIndex, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpFeatureBuf, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpParentBuf);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiEnumFeaturesW' -Namespace Win32 -PassThru
# $api::MsiEnumFeaturesW(szProduct, iFeatureIndex, lpFeatureBuf, lpParentBuf)
#uselib "msi.dll"
#func global MsiEnumFeaturesW "MsiEnumFeaturesW" wptr, wptr, wptr, wptr
; MsiEnumFeaturesW szProduct, iFeatureIndex, varptr(lpFeatureBuf), varptr(lpParentBuf)   ; 戻り値は stat
; szProduct : LPCWSTR -> "wptr"
; iFeatureIndex : DWORD -> "wptr"
; lpFeatureBuf : LPWSTR out -> "wptr"
; lpParentBuf : LPWSTR optional, out -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "msi.dll"
#cfunc global MsiEnumFeaturesW "MsiEnumFeaturesW" wstr, int, var, var
; res = MsiEnumFeaturesW(szProduct, iFeatureIndex, lpFeatureBuf, lpParentBuf)
; szProduct : LPCWSTR -> "wstr"
; iFeatureIndex : DWORD -> "int"
; lpFeatureBuf : LPWSTR out -> "var"
; lpParentBuf : LPWSTR optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; DWORD MsiEnumFeaturesW(LPCWSTR szProduct, DWORD iFeatureIndex, LPWSTR lpFeatureBuf, LPWSTR lpParentBuf)
#uselib "msi.dll"
#cfunc global MsiEnumFeaturesW "MsiEnumFeaturesW" wstr, int, var, var
; res = MsiEnumFeaturesW(szProduct, iFeatureIndex, lpFeatureBuf, lpParentBuf)
; szProduct : LPCWSTR -> "wstr"
; iFeatureIndex : DWORD -> "int"
; lpFeatureBuf : LPWSTR out -> "var"
; lpParentBuf : LPWSTR optional, out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	msi = windows.NewLazySystemDLL("msi.dll")
	procMsiEnumFeaturesW = msi.NewProc("MsiEnumFeaturesW")
)

// szProduct (LPCWSTR), iFeatureIndex (DWORD), lpFeatureBuf (LPWSTR out), lpParentBuf (LPWSTR optional, out)
r1, _, err := procMsiEnumFeaturesW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(szProduct))),
	uintptr(iFeatureIndex),
	uintptr(lpFeatureBuf),
	uintptr(lpParentBuf),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function MsiEnumFeaturesW(
  szProduct: PWideChar;   // LPCWSTR
  iFeatureIndex: DWORD;   // DWORD
  lpFeatureBuf: PWideChar;   // LPWSTR out
  lpParentBuf: PWideChar   // LPWSTR optional, out
): DWORD; stdcall;
  external 'msi.dll' name 'MsiEnumFeaturesW';
result := DllCall("msi\MsiEnumFeaturesW"
    , "WStr", szProduct   ; LPCWSTR
    , "UInt", iFeatureIndex   ; DWORD
    , "Ptr", lpFeatureBuf   ; LPWSTR out
    , "Ptr", lpParentBuf   ; LPWSTR optional, out
    , "UInt")   ; return: DWORD
●MsiEnumFeaturesW(szProduct, iFeatureIndex, lpFeatureBuf, lpParentBuf) = DLL("msi.dll", "dword MsiEnumFeaturesW(char*, dword, char*, char*)")
# 呼び出し: MsiEnumFeaturesW(szProduct, iFeatureIndex, lpFeatureBuf, lpParentBuf)
# szProduct : LPCWSTR -> "char*"
# iFeatureIndex : DWORD -> "dword"
# lpFeatureBuf : LPWSTR out -> "char*"
# lpParentBuf : LPWSTR optional, out -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "msi" fn MsiEnumFeaturesW(
    szProduct: [*c]const u16, // LPCWSTR
    iFeatureIndex: u32, // DWORD
    lpFeatureBuf: [*c]u16, // LPWSTR out
    lpParentBuf: [*c]u16 // LPWSTR optional, out
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc MsiEnumFeaturesW(
    szProduct: WideCString,  # LPCWSTR
    iFeatureIndex: uint32,  # DWORD
    lpFeatureBuf: ptr uint16,  # LPWSTR out
    lpParentBuf: ptr uint16  # LPWSTR optional, out
): uint32 {.importc: "MsiEnumFeaturesW", stdcall, dynlib: "msi.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "msi");
extern(Windows)
uint MsiEnumFeaturesW(
    const(wchar)* szProduct,   // LPCWSTR
    uint iFeatureIndex,   // DWORD
    wchar* lpFeatureBuf,   // LPWSTR out
    wchar* lpParentBuf   // LPWSTR optional, out
);
ccall((:MsiEnumFeaturesW, "msi.dll"), stdcall, UInt32,
      (Cwstring, UInt32, Ptr{UInt16}, Ptr{UInt16}),
      szProduct, iFeatureIndex, lpFeatureBuf, lpParentBuf)
# szProduct : LPCWSTR -> Cwstring
# iFeatureIndex : DWORD -> UInt32
# lpFeatureBuf : LPWSTR out -> Ptr{UInt16}
# lpParentBuf : LPWSTR optional, out -> Ptr{UInt16}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
uint32_t MsiEnumFeaturesW(
    const uint16_t* szProduct,
    uint32_t iFeatureIndex,
    uint16_t* lpFeatureBuf,
    uint16_t* lpParentBuf);
]]
local msi = ffi.load("msi")
-- msi.MsiEnumFeaturesW(szProduct, iFeatureIndex, lpFeatureBuf, lpParentBuf)
-- szProduct : LPCWSTR
-- iFeatureIndex : DWORD
-- lpFeatureBuf : LPWSTR out
-- lpParentBuf : LPWSTR optional, out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。
const koffi = require('koffi');
const lib = koffi.load('msi.dll');
const MsiEnumFeaturesW = lib.func('__stdcall', 'MsiEnumFeaturesW', 'uint32_t', ['str16', 'uint32_t', 'uint16_t *', 'uint16_t *']);
// MsiEnumFeaturesW(szProduct, iFeatureIndex, lpFeatureBuf, lpParentBuf)
// szProduct : LPCWSTR -> 'str16'
// iFeatureIndex : DWORD -> 'uint32_t'
// lpFeatureBuf : LPWSTR out -> 'uint16_t *'
// lpParentBuf : LPWSTR optional, out -> 'uint16_t *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("msi.dll", {
  MsiEnumFeaturesW: { parameters: ["buffer", "u32", "buffer", "buffer"], result: "u32" },
});
// lib.symbols.MsiEnumFeaturesW(szProduct, iFeatureIndex, lpFeatureBuf, lpParentBuf)
// szProduct : LPCWSTR -> "buffer"
// iFeatureIndex : DWORD -> "u32"
// lpFeatureBuf : LPWSTR out -> "buffer"
// lpParentBuf : LPWSTR optional, out -> "buffer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t MsiEnumFeaturesW(
    const uint16_t* szProduct,
    uint32_t iFeatureIndex,
    uint16_t* lpFeatureBuf,
    uint16_t* lpParentBuf);
C, "msi.dll");
// $ffi->MsiEnumFeaturesW(szProduct, iFeatureIndex, lpFeatureBuf, lpParentBuf);
// szProduct : LPCWSTR
// iFeatureIndex : DWORD
// lpFeatureBuf : LPWSTR out
// lpParentBuf : LPWSTR optional, 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.UNICODE_OPTIONS);
    int MsiEnumFeaturesW(
        WString szProduct,   // LPCWSTR
        int iFeatureIndex,   // DWORD
        char[] lpFeatureBuf,   // LPWSTR out
        char[] lpParentBuf   // LPWSTR optional, out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("msi")]
lib Libmsi
  fun MsiEnumFeaturesW = MsiEnumFeaturesW(
    szProduct : UInt16*,   # LPCWSTR
    iFeatureIndex : UInt32,   # DWORD
    lpFeatureBuf : UInt16*,   # LPWSTR out
    lpParentBuf : UInt16*   # LPWSTR optional, out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef MsiEnumFeaturesWNative = Uint32 Function(Pointer<Utf16>, Uint32, Pointer<Utf16>, Pointer<Utf16>);
typedef MsiEnumFeaturesWDart = int Function(Pointer<Utf16>, int, Pointer<Utf16>, Pointer<Utf16>);
final MsiEnumFeaturesW = DynamicLibrary.open('msi.dll')
    .lookupFunction<MsiEnumFeaturesWNative, MsiEnumFeaturesWDart>('MsiEnumFeaturesW');
// szProduct : LPCWSTR -> Pointer<Utf16>
// iFeatureIndex : DWORD -> Uint32
// lpFeatureBuf : LPWSTR out -> Pointer<Utf16>
// lpParentBuf : LPWSTR optional, out -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function MsiEnumFeaturesW(
  szProduct: PWideChar;   // LPCWSTR
  iFeatureIndex: DWORD;   // DWORD
  lpFeatureBuf: PWideChar;   // LPWSTR out
  lpParentBuf: PWideChar   // LPWSTR optional, out
): DWORD; stdcall;
  external 'msi.dll' name 'MsiEnumFeaturesW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "MsiEnumFeaturesW"
  c_MsiEnumFeaturesW :: CWString -> Word32 -> CWString -> CWString -> IO Word32
-- szProduct : LPCWSTR -> CWString
-- iFeatureIndex : DWORD -> Word32
-- lpFeatureBuf : LPWSTR out -> CWString
-- lpParentBuf : LPWSTR optional, out -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let msienumfeaturesw =
  foreign "MsiEnumFeaturesW"
    ((ptr uint16_t) @-> uint32_t @-> (ptr uint16_t) @-> (ptr uint16_t) @-> returning uint32_t)
(* szProduct : LPCWSTR -> (ptr uint16_t) *)
(* iFeatureIndex : DWORD -> uint32_t *)
(* lpFeatureBuf : LPWSTR out -> (ptr uint16_t) *)
(* lpParentBuf : LPWSTR optional, out -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library msi (t "msi.dll"))
(cffi:use-foreign-library msi)

(cffi:defcfun ("MsiEnumFeaturesW" msi-enum-features-w :convention :stdcall) :uint32
  (sz-product (:string :encoding :utf-16le))   ; LPCWSTR
  (i-feature-index :uint32)   ; DWORD
  (lp-feature-buf :pointer)   ; LPWSTR out
  (lp-parent-buf :pointer))   ; LPWSTR optional, out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MsiEnumFeaturesW = Win32::API::More->new('msi',
    'DWORD MsiEnumFeaturesW(LPCWSTR szProduct, DWORD iFeatureIndex, LPWSTR lpFeatureBuf, LPWSTR lpParentBuf)');
# my $ret = $MsiEnumFeaturesW->Call($szProduct, $iFeatureIndex, $lpFeatureBuf, $lpParentBuf);
# szProduct : LPCWSTR -> LPCWSTR
# iFeatureIndex : DWORD -> DWORD
# lpFeatureBuf : LPWSTR out -> LPWSTR
# lpParentBuf : LPWSTR optional, out -> LPWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い