Win32 API 日本語リファレンス
ホーム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
);

パラメーター

名前方向
lpUpgradeCodeLPCWSTRin
dwReservedDWORDoptional
iProductIndexDWORDin
lpProductBufLPWSTRout

戻り値の型: DWORD

各言語での呼び出し定義

// 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 方式にも切替可。
出力引数:
; DWORD MsiEnumRelatedProductsW(LPCWSTR lpUpgradeCode, DWORD dwReserved, DWORD iProductIndex, LPWSTR lpProductBuf)
#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 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	msi = windows.NewLazySystemDLL("msi.dll")
	procMsiEnumRelatedProductsW = msi.NewProc("MsiEnumRelatedProductsW")
)

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