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

MsiCreateRecord

関数
指定フィールド数の新しいレコードを作成してハンドルを返す。
DLLmsi.dll呼出規約winapi対応OSwindows8.0

シグネチャ

// msi.dll
#include <windows.h>

MSIHANDLE MsiCreateRecord(
    DWORD cParams
);

パラメーター

名前方向説明
cParamsDWORDinレコードが持つフィールドの数を指定します。レコード内のフィールドの最大数は 65535 に制限されています。

戻り値の型: MSIHANDLE

公式ドキュメント

MsiCreateRecord 関数は、指定された数のフィールドを持つ新しいレコードオブジェクトを作成します。この関数は、MsiCloseHandle を使用して閉じる必要があるハンドルを返します。

戻り値

関数が成功した場合、戻り値は新しいレコードオブジェクトへのハンドルです。

関数が失敗した場合、戻り値は null です。

解説(Remarks)

MsiCreateRecord 関数によって作成されたレコードオブジェクトのフィールド 0 は、書式指定文字列および操作コードに使用され、cParams で指定される数には含まれません。すべてのフィールドは null に初期化されます。

なお、PMSIHANDLE 型の変数を使用することをお勧めします。PMSIHANDLE オブジェクトはスコープ外になるとインストーラーによって閉じられるのに対し、MSIHANDLE オブジェクトは MsiCloseHandle を呼び出して自分で閉じる必要があるためです。詳細については、Windows インストーラーのベストプラクティスHANDLE の代わりに PMSIHANDLE を使用するのセクションを参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

// msi.dll
#include <windows.h>

MSIHANDLE MsiCreateRecord(
    DWORD cParams
);
[DllImport("msi.dll", ExactSpelling = true)]
static extern uint MsiCreateRecord(
    uint cParams   // DWORD
);
<DllImport("msi.dll", ExactSpelling:=True)>
Public Shared Function MsiCreateRecord(
    cParams As UInteger   ' DWORD
) As UInteger
End Function
' cParams : DWORD
Declare PtrSafe Function MsiCreateRecord Lib "msi" ( _
    ByVal cParams As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

MsiCreateRecord = ctypes.windll.msi.MsiCreateRecord
MsiCreateRecord.restype = wintypes.DWORD
MsiCreateRecord.argtypes = [
    wintypes.DWORD,  # cParams : DWORD
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiCreateRecord = Fiddle::Function.new(
  lib['MsiCreateRecord'],
  [
    -Fiddle::TYPE_INT,  # cParams : DWORD
  ],
  -Fiddle::TYPE_INT)
#[link(name = "msi")]
extern "system" {
    fn MsiCreateRecord(
        cParams: u32  // DWORD
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("msi.dll")]
public static extern uint MsiCreateRecord(uint cParams);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiCreateRecord' -Namespace Win32 -PassThru
# $api::MsiCreateRecord(cParams)
#uselib "msi.dll"
#func global MsiCreateRecord "MsiCreateRecord" sptr
; MsiCreateRecord cParams   ; 戻り値は stat
; cParams : DWORD -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "msi.dll"
#cfunc global MsiCreateRecord "MsiCreateRecord" int
; res = MsiCreateRecord(cParams)
; cParams : DWORD -> "int"
; MSIHANDLE MsiCreateRecord(DWORD cParams)
#uselib "msi.dll"
#cfunc global MsiCreateRecord "MsiCreateRecord" int
; res = MsiCreateRecord(cParams)
; cParams : DWORD -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	msi = windows.NewLazySystemDLL("msi.dll")
	procMsiCreateRecord = msi.NewProc("MsiCreateRecord")
)

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

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

typedef MsiCreateRecordNative = Uint32 Function(Uint32);
typedef MsiCreateRecordDart = int Function(int);
final MsiCreateRecord = DynamicLibrary.open('msi.dll')
    .lookupFunction<MsiCreateRecordNative, MsiCreateRecordDart>('MsiCreateRecord');
// cParams : DWORD -> Uint32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function MsiCreateRecord(
  cParams: DWORD   // DWORD
): DWORD; stdcall;
  external 'msi.dll' name 'MsiCreateRecord';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "MsiCreateRecord"
  c_MsiCreateRecord :: Word32 -> IO Word32
-- cParams : DWORD -> Word32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let msicreaterecord =
  foreign "MsiCreateRecord"
    (uint32_t @-> returning uint32_t)
(* cParams : DWORD -> uint32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library msi (t "msi.dll"))
(cffi:use-foreign-library msi)

(cffi:defcfun ("MsiCreateRecord" msi-create-record :convention :stdcall) :uint32
  (c-params :uint32))   ; DWORD
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MsiCreateRecord = Win32::API::More->new('msi',
    'DWORD MsiCreateRecord(DWORD cParams)');
# my $ret = $MsiCreateRecord->Call($cParams);
# cParams : DWORD -> DWORD
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。