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

MsiFormatRecordW

関数
レコード内のフィールドとプロパティを書式化して文字列を生成する(Unicode版)。
DLLmsi.dll文字セットUnicode (-W)呼出規約winapi対応OSwindows8.0

シグネチャ

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

DWORD MsiFormatRecordW(
    MSIHANDLE hInstall,
    MSIHANDLE hRecord,
    LPWSTR szResultBuf,   // optional
    DWORD* pcchResultBuf   // optional
);

パラメーター

名前方向
hInstallMSIHANDLEin
hRecordMSIHANDLEin
szResultBufLPWSTRoutoptional
pcchResultBufDWORD*inoutoptional

戻り値の型: DWORD

各言語での呼び出し定義

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

DWORD MsiFormatRecordW(
    MSIHANDLE hInstall,
    MSIHANDLE hRecord,
    LPWSTR szResultBuf,   // optional
    DWORD* pcchResultBuf   // optional
);
[DllImport("msi.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint MsiFormatRecordW(
    uint hInstall,   // MSIHANDLE
    uint hRecord,   // MSIHANDLE
    [MarshalAs(UnmanagedType.LPWStr)] System.Text.StringBuilder szResultBuf,   // LPWSTR optional, out
    IntPtr pcchResultBuf   // DWORD* optional, in/out
);
<DllImport("msi.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function MsiFormatRecordW(
    hInstall As UInteger,   ' MSIHANDLE
    hRecord As UInteger,   ' MSIHANDLE
    <MarshalAs(UnmanagedType.LPWStr)> szResultBuf As System.Text.StringBuilder,   ' LPWSTR optional, out
    pcchResultBuf As IntPtr   ' DWORD* optional, in/out
) As UInteger
End Function
' hInstall : MSIHANDLE
' hRecord : MSIHANDLE
' szResultBuf : LPWSTR optional, out
' pcchResultBuf : DWORD* optional, in/out
Declare PtrSafe Function MsiFormatRecordW Lib "msi" ( _
    ByVal hInstall As Long, _
    ByVal hRecord As Long, _
    ByVal szResultBuf As LongPtr, _
    ByVal pcchResultBuf 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

MsiFormatRecordW = ctypes.windll.msi.MsiFormatRecordW
MsiFormatRecordW.restype = wintypes.DWORD
MsiFormatRecordW.argtypes = [
    wintypes.DWORD,  # hInstall : MSIHANDLE
    wintypes.DWORD,  # hRecord : MSIHANDLE
    wintypes.LPWSTR,  # szResultBuf : LPWSTR optional, out
    ctypes.POINTER(wintypes.DWORD),  # pcchResultBuf : DWORD* optional, in/out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	msi = windows.NewLazySystemDLL("msi.dll")
	procMsiFormatRecordW = msi.NewProc("MsiFormatRecordW")
)

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