ホーム › System.ApplicationInstallationAndServicing › MsiEnumProductsW

MsiEnumProductsW

関数

インストール済みの製品をインデックス順に列挙して製品コードを取得する。

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

シグネチャ

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

DWORD MsiEnumProductsW(
    DWORD iProductIndex,
    LPWSTR lpProductBuf
);

パラメーター

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

戻り値の型: DWORD

公式ドキュメント

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

戻り値

値	意味
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 ヘッダーは、MsiEnumProducts を、UNICODE プリプロセッサ定数の定義に基づいてこの関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして定義しています。エンコーディング中立のエイリアスの使用を、エンコーディング中立でないコードと混在させると、不一致が生じてコンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、関数プロトタイプの規則を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 MsiEnumProductsW(
    DWORD iProductIndex,
    LPWSTR lpProductBuf
);

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

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

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

MsiEnumProductsW = ctypes.windll.msi.MsiEnumProductsW
MsiEnumProductsW.restype = wintypes.DWORD
MsiEnumProductsW.argtypes = [
    wintypes.DWORD,  # iProductIndex : DWORD
    wintypes.LPWSTR,  # lpProductBuf : LPWSTR out
]

require 'fiddle'
require 'fiddle/import'

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

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

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

出力引数:

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