ホーム › System.ApplicationInstallationAndServicing › MsiEnumRelatedProductsW

MsiEnumRelatedProductsW

関数

アップグレードコードに関連する製品をインデックス順に列挙する。

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

シグネチャ

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

DWORD MsiEnumRelatedProductsW(
    LPCWSTR lpUpgradeCode,
    DWORD dwReserved,   // optional
    DWORD iProductIndex,
    LPWSTR lpProductBuf
);

パラメーター

名前	型	方向	説明
lpUpgradeCode	LPCWSTR	in	インストーラーが列挙する関連製品のアップグレードコードを指定する、null で終わる文字列です。
dwReserved	DWORD	optional	このパラメーターは予約されており、0 を指定する必要があります。
iProductIndex	DWORD	in	登録済み製品に対する 0 から始まるインデックスです。
lpProductBuf	LPWSTR	out	製品コード GUID を受け取るバッファーです。このバッファーの長さは 39 文字である必要があります。最初の 38 文字は GUID 用で、最後の 1 文字は終端の null 文字用です。

戻り値の型: DWORD

公式ドキュメント

MsiEnumRelatedProducts 関数は、指定したアップグレードコードを持つ製品を列挙します。この関数は、Property テーブルに指定の UpgradeCode プロパティを持ち、現在インストールまたはアドバタイズされている製品を一覧します。(Unicode)

戻り値

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

解説(Remarks)

UpgradeCode プロパティを参照してください。

特定のアップグレードコードを持ち、現在インストールまたはアドバタイズされている製品を列挙するには、アプリケーションはまず iProductIndex パラメーターを 0 に設定して MsiEnumRelatedProducts 関数を呼び出します。次に、iProductIndex パラメーターをインクリメントしながら、関数が ERROR_NO_MORE_ITEMS を返すまで MsiEnumRelatedProducts を呼び出します。ERROR_NO_MORE_ITEMS は、指定したアップグレードコードを持つ製品がこれ以上ないことを意味します。

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

メモ

msi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして MsiEnumRelatedProducts を定義します。エンコーディングに依存しないエイリアスの使用と、エンコーディングに依存しないわけではないコードを混在させると、不一致が生じ、コンパイルエラーまたは実行時エラーを引き起こす可能性があります。詳細については、関数プロトタイプの規則を参照してください。

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

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

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

' lpUpgradeCode : LPCWSTR
' dwReserved : DWORD optional
' iProductIndex : DWORD
' lpProductBuf : LPWSTR out
Declare PtrSafe Function MsiEnumRelatedProductsW Lib "msi" ( _
    ByVal lpUpgradeCode As LongPtr, _
    ByVal dwReserved As Long, _
    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

MsiEnumRelatedProductsW = ctypes.windll.msi.MsiEnumRelatedProductsW
MsiEnumRelatedProductsW.restype = wintypes.DWORD
MsiEnumRelatedProductsW.argtypes = [
    wintypes.LPCWSTR,  # lpUpgradeCode : LPCWSTR
    wintypes.DWORD,  # dwReserved : DWORD optional
    wintypes.DWORD,  # iProductIndex : DWORD
    wintypes.LPWSTR,  # lpProductBuf : LPWSTR out
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiEnumRelatedProductsW = Fiddle::Function.new(
  lib['MsiEnumRelatedProductsW'],
  [
    Fiddle::TYPE_VOIDP,  # lpUpgradeCode : LPCWSTR
    -Fiddle::TYPE_INT,  # dwReserved : DWORD optional
    -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 MsiEnumRelatedProductsW(
        lpUpgradeCode: *const u16,  // LPCWSTR
        dwReserved: u32,  // DWORD optional
        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 MsiEnumRelatedProductsW([MarshalAs(UnmanagedType.LPWStr)] string lpUpgradeCode, uint dwReserved, uint iProductIndex, [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder lpProductBuf);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiEnumRelatedProductsW' -Namespace Win32 -PassThru
# $api::MsiEnumRelatedProductsW(lpUpgradeCode, dwReserved, iProductIndex, lpProductBuf)

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

出力引数:

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