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

MsiEnumProductsA

関数
インストール済みの製品をインデックス順に列挙して製品コードを取得する。
DLLmsi.dll文字セットANSI (-A)呼出規約winapi対応OSwindows8.0
📘 Microsoft Learn (日本語) · English

シグネチャ

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

DWORD MsiEnumProductsA(
    DWORD iProductIndex,
    LPSTR lpProductBuf
);

パラメーター

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

戻り値の型: DWORD

公式ドキュメント

MsiEnumProducts 関数は、現在アドバタイズまたはインストールされているすべての製品を列挙します。ユーザー単位およびマシン単位の両方のインストールコンテキストにインストールされている製品と、アドバタイズされている製品が列挙されます。(ANSI)

戻り値

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

解説(Remarks)

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

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

メモ

msi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして MsiEnumProducts を定義します。エンコーディングに依存しないエイリアスの使用と、エンコーディングに依存しないわけではないコードを混在させると、コンパイルエラーまたは実行時エラーを引き起こす不一致につながる可能性があります。詳細については、「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 MsiEnumProductsA(
    DWORD iProductIndex,
    LPSTR lpProductBuf
);
[DllImport("msi.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint MsiEnumProductsA(
    uint iProductIndex,   // DWORD
    [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpProductBuf   // LPSTR out
);
<DllImport("msi.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function MsiEnumProductsA(
    iProductIndex As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPStr)> lpProductBuf As System.Text.StringBuilder   ' LPSTR out
) As UInteger
End Function
' iProductIndex : DWORD
' lpProductBuf : LPSTR out
Declare PtrSafe Function MsiEnumProductsA Lib "msi" ( _
    ByVal iProductIndex As Long, _
    ByVal lpProductBuf As String) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

MsiEnumProductsA = ctypes.windll.msi.MsiEnumProductsA
MsiEnumProductsA.restype = wintypes.DWORD
MsiEnumProductsA.argtypes = [
    wintypes.DWORD,  # iProductIndex : DWORD
    wintypes.LPSTR,  # lpProductBuf : LPSTR out
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiEnumProductsA = Fiddle::Function.new(
  lib['MsiEnumProductsA'],
  [
    -Fiddle::TYPE_INT,  # iProductIndex : DWORD
    Fiddle::TYPE_VOIDP,  # lpProductBuf : LPSTR out
  ],
  -Fiddle::TYPE_INT)
#[link(name = "msi")]
extern "system" {
    fn MsiEnumProductsA(
        iProductIndex: u32,  // DWORD
        lpProductBuf: *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 MsiEnumProductsA(uint iProductIndex, [MarshalAs(UnmanagedType.LPStr)] System.Text.StringBuilder lpProductBuf);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiEnumProductsA' -Namespace Win32 -PassThru
# $api::MsiEnumProductsA(iProductIndex, lpProductBuf)
#uselib "msi.dll"
#func global MsiEnumProductsA "MsiEnumProductsA" sptr, sptr
; MsiEnumProductsA iProductIndex, varptr(lpProductBuf)   ; 戻り値は stat
; iProductIndex : DWORD -> "sptr"
; lpProductBuf : LPSTR out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数: 
#uselib "msi.dll"
#cfunc global MsiEnumProductsA "MsiEnumProductsA" int, var
; res = MsiEnumProductsA(iProductIndex, lpProductBuf)
; iProductIndex : DWORD -> "int"
; lpProductBuf : LPSTR out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数: 
; DWORD MsiEnumProductsA(DWORD iProductIndex, LPSTR lpProductBuf)
#uselib "msi.dll"
#cfunc global MsiEnumProductsA "MsiEnumProductsA" int, var
; res = MsiEnumProductsA(iProductIndex, lpProductBuf)
; iProductIndex : DWORD -> "int"
; lpProductBuf : LPSTR out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	msi = windows.NewLazySystemDLL("msi.dll")
	procMsiEnumProductsA = msi.NewProc("MsiEnumProductsA")
)

// iProductIndex (DWORD), lpProductBuf (LPSTR out)
r1, _, err := procMsiEnumProductsA.Call(
	uintptr(iProductIndex),
	uintptr(lpProductBuf),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function MsiEnumProductsA(
  iProductIndex: DWORD;   // DWORD
  lpProductBuf: PAnsiChar   // LPSTR out
): DWORD; stdcall;
  external 'msi.dll' name 'MsiEnumProductsA';
result := DllCall("msi\MsiEnumProductsA"
    , "UInt", iProductIndex   ; DWORD
    , "Ptr", lpProductBuf   ; LPSTR out
    , "UInt")   ; return: DWORD
●MsiEnumProductsA(iProductIndex, lpProductBuf) = DLL("msi.dll", "dword MsiEnumProductsA(dword, char*)")
# 呼び出し: MsiEnumProductsA(iProductIndex, lpProductBuf)
# iProductIndex : DWORD -> "dword"
# lpProductBuf : LPSTR out -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

extern "msi" fn MsiEnumProductsA(
    iProductIndex: u32, // DWORD
    lpProductBuf: [*c]u8 // LPSTR out
) callconv(std.os.windows.WINAPI) u32;
proc MsiEnumProductsA(
    iProductIndex: uint32,  # DWORD
    lpProductBuf: ptr char  # LPSTR out
): uint32 {.importc: "MsiEnumProductsA", stdcall, dynlib: "msi.dll".}
pragma(lib, "msi");
extern(Windows)
uint MsiEnumProductsA(
    uint iProductIndex,   // DWORD
    char* lpProductBuf   // LPSTR out
);
ccall((:MsiEnumProductsA, "msi.dll"), stdcall, UInt32,
      (UInt32, Ptr{UInt8}),
      iProductIndex, lpProductBuf)
# iProductIndex : DWORD -> UInt32
# lpProductBuf : LPSTR out -> Ptr{UInt8}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t MsiEnumProductsA(
    uint32_t iProductIndex,
    char* lpProductBuf);
]]
local msi = ffi.load("msi")
-- msi.MsiEnumProductsA(iProductIndex, lpProductBuf)
-- iProductIndex : DWORD
-- lpProductBuf : LPSTR out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('msi.dll');
const MsiEnumProductsA = lib.func('__stdcall', 'MsiEnumProductsA', 'uint32_t', ['uint32_t', 'char *']);
// MsiEnumProductsA(iProductIndex, lpProductBuf)
// iProductIndex : DWORD -> 'uint32_t'
// lpProductBuf : LPSTR out -> 'char *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("msi.dll", {
  MsiEnumProductsA: { parameters: ["u32", "buffer"], result: "u32" },
});
// lib.symbols.MsiEnumProductsA(iProductIndex, lpProductBuf)
// iProductIndex : DWORD -> "u32"
// lpProductBuf : LPSTR out -> "buffer"
// 文字列は "buffer"。ANSI(-A) は new TextEncoder() で UTF-8/ANSI バイト列(末尾に \x00)を渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t MsiEnumProductsA(
    uint32_t iProductIndex,
    char* lpProductBuf);
C, "msi.dll");
// $ffi->MsiEnumProductsA(iProductIndex, lpProductBuf);
// iProductIndex : DWORD
// lpProductBuf : LPSTR 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.ASCII_OPTIONS);
    int MsiEnumProductsA(
        int iProductIndex,   // DWORD
        byte[] lpProductBuf   // LPSTR out
    );
}
@[Link("msi")]
lib Libmsi
  fun MsiEnumProductsA = MsiEnumProductsA(
    iProductIndex : UInt32,   # DWORD
    lpProductBuf : UInt8*   # LPSTR out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef MsiEnumProductsANative = Uint32 Function(Uint32, Pointer<Utf8>);
typedef MsiEnumProductsADart = int Function(int, Pointer<Utf8>);
final MsiEnumProductsA = DynamicLibrary.open('msi.dll')
    .lookupFunction<MsiEnumProductsANative, MsiEnumProductsADart>('MsiEnumProductsA');
// iProductIndex : DWORD -> Uint32
// lpProductBuf : LPSTR out -> Pointer<Utf8>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function MsiEnumProductsA(
  iProductIndex: DWORD;   // DWORD
  lpProductBuf: PAnsiChar   // LPSTR out
): DWORD; stdcall;
  external 'msi.dll' name 'MsiEnumProductsA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "MsiEnumProductsA"
  c_MsiEnumProductsA :: Word32 -> CString -> IO Word32
-- iProductIndex : DWORD -> Word32
-- lpProductBuf : LPSTR out -> CString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let msienumproductsa =
  foreign "MsiEnumProductsA"
    (uint32_t @-> string @-> returning uint32_t)
(* iProductIndex : DWORD -> uint32_t *)
(* lpProductBuf : LPSTR out -> string *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library msi (t "msi.dll"))
(cffi:use-foreign-library msi)

(cffi:defcfun ("MsiEnumProductsA" msi-enum-products-a :convention :stdcall) :uint32
  (i-product-index :uint32)   ; DWORD
  (lp-product-buf :pointer))   ; LPSTR out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MsiEnumProductsA = Win32::API::More->new('msi',
    'DWORD MsiEnumProductsA(DWORD iProductIndex, LPSTR lpProductBuf)');
# my $ret = $MsiEnumProductsA->Call($iProductIndex, $lpProductBuf);
# iProductIndex : DWORD -> DWORD
# lpProductBuf : LPSTR out -> LPSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い
類似 API