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

MsiFormatRecordA

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

シグネチャ

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

DWORD MsiFormatRecordA(
    MSIHANDLE hInstall,
    MSIHANDLE hRecord,
    LPSTR szResultBuf,   // optional
    DWORD* pcchResultBuf   // optional
);

パラメーター

名前方向説明
hInstallMSIHANDLEinインストールへのハンドル。省略可能です。省略した場合、レコードのフィールドパラメーターのみが処理され、プロパティは置換に使用できません。
hRecordMSIHANDLEin書式設定するレコードへのハンドル。テンプレート文字列をレコードのフィールド 0 に格納し、それに続いて参照されるデータパラメーターを格納する必要があります。
szResultBufLPSTRoutoptionalnull で終わる書式設定済み文字列を受け取るバッファーへのポインター。szResultBuf に null(値 = 0)を渡してバッファーのサイズを取得しようとしないでください。バッファーのサイズを取得するには、空の文字列(例: "")を渡します。この場合、関数は ERROR_MORE_DATA を返し、pcchResultBuf には終端の null 文字を含まない、必要なバッファーサイズが TCHAR 単位で格納されます。ERROR_SUCCESS が返された場合、pcchResultBuf には終端の null 文字を含まない、バッファーに書き込まれた TCHAR 数が格納されます。
pcchResultBufDWORD*inoutoptional変数 szResultBuf が指すバッファーのサイズを TCHAR 単位で指定する変数へのポインター。関数が ERROR_SUCCESS を返すと、この変数には終端の null 文字を含まない、szResultBuf にコピーされたデータのサイズが格納されます。szResultBuf が十分な大きさでない場合、関数は ERROR_MORE_DATA を返し、終端の null 文字を含まない必要なサイズを pcchResultBuf が指す変数に格納します。

戻り値の型: DWORD

公式ドキュメント

MsiFormatRecord 関数は、書式文字列を使用してレコードのフィールドデータおよびプロパティを書式設定します。(ANSI)

戻り値

MsiFormatRecord 関数は、次のいずれかの値を返します。

解説(Remarks)

MsiFormatRecord 関数は、次の書式設定処理を使用します。

書式設定されるパラメーターは角かっこ [...] で囲みます。置換は内側から外側へと解決されるため、角かっこを入れ子にすることができます。

文字列の一部が波かっこ { } で囲まれ、角かっこを含まない場合、その部分は波かっこを含めて変更されずにそのまま残ります。

文字列の一部が波かっこ { } で囲まれ、1 つ以上のプロパティ名を含む場合、すべてのプロパティが見つかれば、そのテキストは(解決された置換を含めて)波かっこなしで表示されます。いずれかのプロパティが見つからない場合、波かっこ内のすべてのテキストおよび波かっこ自体が削除されます。

遅延実行カスタムアクションの場合、MsiFormatRecordCustomActionData プロパティと ProductCode プロパティのみをサポートすることに注意してください。詳細については、Obtaining Context Information for Deferred Execution Custom Actions を参照してください。

次の手順では、MsiFormatRecord 関数を使用して文字列を書式設定する方法を説明します。

MsiFormatRecord 関数を使用して文字列を書式設定するには

  1. 数値パラメーターは、マーカーを対応するレコードフィールドの値で置き換えることによって置換されます。値が欠落している場合や null の場合はテキストが生成されません。
  2. 結果の文字列は、非レコードパラメーターを対応する値で置き換えることによって処理されます。これについては次に説明します。
    • "[propertyname]" の形式の部分文字列が検出された場合、それはプロパティの値で置き換えられます。
    • "[%environmentvariable]" の形式の部分文字列が見つかった場合、環境変数の値が置換されます。
    • " [#filekey]" の形式の部分文字列が見つかった場合、それはファイルのフルパスで置き換えられます。値 filekeyFile テーブルのキーとして使用されます。"[#filekey]" の値は、インストーラーが CostInitialize アクションFileCost アクション、および CostFinalize アクションを実行するまで空白のままで、パスに置き換えられません。"[#filekey]" の値は、そのファイルが属するコンポーネントのインストール状態によって異なります。コンポーネントがソースから実行される場合、値はファイルのソースの場所へのパスです。コンポーネントがローカルで実行される場合、値はインストール後のファイルのターゲットの場所へのパスです。コンポーネントが存在しない場合、パスは空白になります。コンポーネントのインストール状態の確認の詳細については、Checking the Installation of Features, Components, Files を参照してください。
    • "[$componentkey]" の形式の部分文字列が見つかった場合、それはコンポーネントのインストールディレクトリで置き換えられます。値 componentkeyComponent テーブルのキーとして使用されます。"[$componentkey]" の値は、インストーラーが CostInitialize アクションFileCost アクション、および CostFinalize アクションを実行するまで空白のままで、ディレクトリに置き換えられません。"[$componentkey]" の値は、コンポーネントのインストール状態によって異なります。コンポーネントがソースから実行される場合、値はファイルのソースディレクトリです。コンポーネントがローカルで実行される場合、値はインストール後のターゲットディレクトリです。コンポーネントが存在しない場合、値は空白のままになります。コンポーネントのインストール状態の確認の詳細については、Checking the Installation of Features, Components, Files を参照してください。
    • コンポーネントが既にインストールされており、現在のインストール中に再インストール、削除、または移動が行われない場合、そのコンポーネントのアクション状態は null となるため、文字列 "[$componentkey]" は Null として評価されることに注意してください。
    • "[\c]" の形式の部分文字列が見つかった場合、それ以上の処理を行わずにその文字で置き換えられます。バックスラッシュの後の最初の文字のみが保持され、それ以外はすべて削除されます。
ERROR_MORE_DATA が返された場合、ポインターであるパラメーターは、文字列を保持するために必要なバッファーのサイズを示します。ERROR_SUCCESS が返された場合、文字列バッファーに書き込まれた文字数を示します。したがって、バッファーを指定するパラメーターに空の文字列(例: "")を渡すことで、バッファーのサイズを取得できます。Null(値 = 0)を渡してバッファーのサイズを取得しようとしないでください。
メモ

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

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

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

var (
	msi = windows.NewLazySystemDLL("msi.dll")
	procMsiFormatRecordA = msi.NewProc("MsiFormatRecordA")
)

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

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

typedef MsiFormatRecordANative = Uint32 Function(Uint32, Uint32, Pointer<Utf8>, Pointer<Uint32>);
typedef MsiFormatRecordADart = int Function(int, int, Pointer<Utf8>, Pointer<Uint32>);
final MsiFormatRecordA = DynamicLibrary.open('msi.dll')
    .lookupFunction<MsiFormatRecordANative, MsiFormatRecordADart>('MsiFormatRecordA');
// hInstall : MSIHANDLE -> Uint32
// hRecord : MSIHANDLE -> Uint32
// szResultBuf : LPSTR optional, out -> Pointer<Utf8>
// pcchResultBuf : DWORD* optional, in/out -> Pointer<Uint32>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function MsiFormatRecordA(
  hInstall: DWORD;   // MSIHANDLE
  hRecord: DWORD;   // MSIHANDLE
  szResultBuf: PAnsiChar;   // LPSTR optional, out
  pcchResultBuf: Pointer   // DWORD* optional, in/out
): DWORD; stdcall;
  external 'msi.dll' name 'MsiFormatRecordA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "MsiFormatRecordA"
  c_MsiFormatRecordA :: Word32 -> Word32 -> CString -> Ptr Word32 -> IO Word32
-- hInstall : MSIHANDLE -> Word32
-- hRecord : MSIHANDLE -> Word32
-- szResultBuf : LPSTR optional, out -> CString
-- pcchResultBuf : DWORD* optional, in/out -> Ptr Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let msiformatrecorda =
  foreign "MsiFormatRecordA"
    (uint32_t @-> uint32_t @-> string @-> (ptr uint32_t) @-> returning uint32_t)
(* hInstall : MSIHANDLE -> uint32_t *)
(* hRecord : MSIHANDLE -> uint32_t *)
(* szResultBuf : LPSTR optional, out -> string *)
(* pcchResultBuf : DWORD* optional, in/out -> (ptr uint32_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library msi (t "msi.dll"))
(cffi:use-foreign-library msi)

(cffi:defcfun ("MsiFormatRecordA" msi-format-record-a :convention :stdcall) :uint32
  (h-install :uint32)   ; MSIHANDLE
  (h-record :uint32)   ; MSIHANDLE
  (sz-result-buf :pointer)   ; LPSTR optional, out
  (pcch-result-buf :pointer))   ; DWORD* optional, in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MsiFormatRecordA = Win32::API::More->new('msi',
    'DWORD MsiFormatRecordA(DWORD hInstall, DWORD hRecord, LPSTR szResultBuf, LPVOID pcchResultBuf)');
# my $ret = $MsiFormatRecordA->Call($hInstall, $hRecord, $szResultBuf, $pcchResultBuf);
# hInstall : MSIHANDLE -> DWORD
# hRecord : MSIHANDLE -> DWORD
# szResultBuf : LPSTR optional, out -> LPSTR
# pcchResultBuf : DWORD* optional, in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い