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

MsiDatabaseGenerateTransformA

関数
2つのデータベースの差分からトランスフォームファイルを生成する。
DLLmsi.dll文字セットANSI (-A)呼出規約winapi対応OSwindows8.0

シグネチャ

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

DWORD MsiDatabaseGenerateTransformA(
    MSIHANDLE hDatabase,
    MSIHANDLE hDatabaseReference,
    LPCSTR szTransformFile,
    INT iReserved1,
    INT iReserved2
);

パラメーター

名前方向説明
hDatabaseMSIHANDLEin変更が含まれているデータベースのハンドル。MsiOpenDatabase から取得します。
hDatabaseReferenceMSIHANDLEin変更が含まれていないデータベースのハンドル。MsiOpenDatabase から取得します。
szTransformFileLPCSTRin生成するトランスフォーム ファイルの名前を指定する null 終端文字列。このパラメーターは null にできます。szTransformFile が null の場合、 MsiDatabaseGenerateTransform を使用して、トランスフォームを作成せずに 2 つのデータベースが同一かどうかをテストできます。データベースが同一の場合、関数は ERROR_NO_DATA を返します。データベースが異なる場合、関数は NOERROR を返します。
iReserved1INTinこれは予約された引数であり、0 に設定する必要があります。
iReserved2INTinこれは予約された引数であり、0 に設定する必要があります。

戻り値の型: DWORD

公式ドキュメント

MsiDatabaseGenerateTransform 関数は、2 つのデータベース間の差分を表すトランスフォーム ファイルを生成します。(ANSI)

戻り値

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

解説(Remarks)

2 つのデータベース間の差分ファイルを生成するには、 MsiDatabaseGenerateTransform 関数を使用します。トランスフォームには、列と行の挿入および削除に関する情報が含まれます。検証フラグは、トランスフォーム ファイルのサマリー情報ストリームに格納されます。

両方のデータベースに存在するテーブルについて、2 つのスキーマ間で許可される唯一の差分は、参照テーブルの末尾への列の追加です。テーブルに主キー列を追加したり、ベース テーブルで定義されている既存の列の順序、名前、または列定義を変更したりすることはできません。言い換えると、いずれのテーブルにもデータが含まれておらず、参照テーブルから列が削除された場合、結果として得られるテーブルはベース テーブルと同一になります。

トランスフォーム、ソース、およびパッチのリスト区切り文字はセミコロンであるため、この文字をファイル名やパスに使用しないでください。

この関数はサマリー情報ストリームを生成しません。既存のトランスフォームに対してストリームを作成するには、 MsiCreateTransformSummaryInfo を使用してください。

szTransformFile が null の場合、トランスフォームを作成せずに 2 つのデータベースが同一かどうかをテストできます。データベースが同一の場合は ERROR_NO_DATA が返され、差分が見つかった場合は NOERROR が返されます。

この関数はカスタム アクションから呼び出すことはできません。カスタム アクションからこの関数を呼び出すと、関数は失敗します。

関数が失敗した場合は、MsiGetLastErrorRecord を使用して拡張エラー情報を取得できます。

メモ

msiquery.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして MsiDatabaseGenerateTransform を定義します。エンコード ニュートラルなエイリアスの使用を、エンコード ニュートラルではないコードと混在させると、不整合が生じ、コンパイル エラーや実行時エラーの原因となる場合があります。詳細については、関数プロトタイプの規則を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 MsiDatabaseGenerateTransformA(
    MSIHANDLE hDatabase,
    MSIHANDLE hDatabaseReference,
    LPCSTR szTransformFile,
    INT iReserved1,
    INT iReserved2
);
[DllImport("msi.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint MsiDatabaseGenerateTransformA(
    uint hDatabase,   // MSIHANDLE
    uint hDatabaseReference,   // MSIHANDLE
    [MarshalAs(UnmanagedType.LPStr)] string szTransformFile,   // LPCSTR
    int iReserved1,   // INT
    int iReserved2   // INT
);
<DllImport("msi.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function MsiDatabaseGenerateTransformA(
    hDatabase As UInteger,   ' MSIHANDLE
    hDatabaseReference As UInteger,   ' MSIHANDLE
    <MarshalAs(UnmanagedType.LPStr)> szTransformFile As String,   ' LPCSTR
    iReserved1 As Integer,   ' INT
    iReserved2 As Integer   ' INT
) As UInteger
End Function
' hDatabase : MSIHANDLE
' hDatabaseReference : MSIHANDLE
' szTransformFile : LPCSTR
' iReserved1 : INT
' iReserved2 : INT
Declare PtrSafe Function MsiDatabaseGenerateTransformA Lib "msi" ( _
    ByVal hDatabase As Long, _
    ByVal hDatabaseReference As Long, _
    ByVal szTransformFile As String, _
    ByVal iReserved1 As Long, _
    ByVal iReserved2 As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

MsiDatabaseGenerateTransformA = ctypes.windll.msi.MsiDatabaseGenerateTransformA
MsiDatabaseGenerateTransformA.restype = wintypes.DWORD
MsiDatabaseGenerateTransformA.argtypes = [
    wintypes.DWORD,  # hDatabase : MSIHANDLE
    wintypes.DWORD,  # hDatabaseReference : MSIHANDLE
    wintypes.LPCSTR,  # szTransformFile : LPCSTR
    ctypes.c_int,  # iReserved1 : INT
    ctypes.c_int,  # iReserved2 : INT
]
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiDatabaseGenerateTransformA = Fiddle::Function.new(
  lib['MsiDatabaseGenerateTransformA'],
  [
    -Fiddle::TYPE_INT,  # hDatabase : MSIHANDLE
    -Fiddle::TYPE_INT,  # hDatabaseReference : MSIHANDLE
    Fiddle::TYPE_VOIDP,  # szTransformFile : LPCSTR
    Fiddle::TYPE_INT,  # iReserved1 : INT
    Fiddle::TYPE_INT,  # iReserved2 : INT
  ],
  -Fiddle::TYPE_INT)
#[link(name = "msi")]
extern "system" {
    fn MsiDatabaseGenerateTransformA(
        hDatabase: u32,  // MSIHANDLE
        hDatabaseReference: u32,  // MSIHANDLE
        szTransformFile: *const u8,  // LPCSTR
        iReserved1: i32,  // INT
        iReserved2: i32  // INT
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[DllImport("msi.dll", CharSet = CharSet.Ansi)]
public static extern uint MsiDatabaseGenerateTransformA(uint hDatabase, uint hDatabaseReference, [MarshalAs(UnmanagedType.LPStr)] string szTransformFile, int iReserved1, int iReserved2);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiDatabaseGenerateTransformA' -Namespace Win32 -PassThru
# $api::MsiDatabaseGenerateTransformA(hDatabase, hDatabaseReference, szTransformFile, iReserved1, iReserved2)
#uselib "msi.dll"
#func global MsiDatabaseGenerateTransformA "MsiDatabaseGenerateTransformA" sptr, sptr, sptr, sptr, sptr
; MsiDatabaseGenerateTransformA hDatabase, hDatabaseReference, szTransformFile, iReserved1, iReserved2   ; 戻り値は stat
; hDatabase : MSIHANDLE -> "sptr"
; hDatabaseReference : MSIHANDLE -> "sptr"
; szTransformFile : LPCSTR -> "sptr"
; iReserved1 : INT -> "sptr"
; iReserved2 : INT -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "msi.dll"
#cfunc global MsiDatabaseGenerateTransformA "MsiDatabaseGenerateTransformA" int, int, str, int, int
; res = MsiDatabaseGenerateTransformA(hDatabase, hDatabaseReference, szTransformFile, iReserved1, iReserved2)
; hDatabase : MSIHANDLE -> "int"
; hDatabaseReference : MSIHANDLE -> "int"
; szTransformFile : LPCSTR -> "str"
; iReserved1 : INT -> "int"
; iReserved2 : INT -> "int"
; DWORD MsiDatabaseGenerateTransformA(MSIHANDLE hDatabase, MSIHANDLE hDatabaseReference, LPCSTR szTransformFile, INT iReserved1, INT iReserved2)
#uselib "msi.dll"
#cfunc global MsiDatabaseGenerateTransformA "MsiDatabaseGenerateTransformA" int, int, str, int, int
; res = MsiDatabaseGenerateTransformA(hDatabase, hDatabaseReference, szTransformFile, iReserved1, iReserved2)
; hDatabase : MSIHANDLE -> "int"
; hDatabaseReference : MSIHANDLE -> "int"
; szTransformFile : LPCSTR -> "str"
; iReserved1 : INT -> "int"
; iReserved2 : INT -> "int"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	msi = windows.NewLazySystemDLL("msi.dll")
	procMsiDatabaseGenerateTransformA = msi.NewProc("MsiDatabaseGenerateTransformA")
)

// hDatabase (MSIHANDLE), hDatabaseReference (MSIHANDLE), szTransformFile (LPCSTR), iReserved1 (INT), iReserved2 (INT)
r1, _, err := procMsiDatabaseGenerateTransformA.Call(
	uintptr(hDatabase),
	uintptr(hDatabaseReference),
	uintptr(unsafe.Pointer(windows.BytePtrFromString(szTransformFile))),
	uintptr(iReserved1),
	uintptr(iReserved2),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function MsiDatabaseGenerateTransformA(
  hDatabase: DWORD;   // MSIHANDLE
  hDatabaseReference: DWORD;   // MSIHANDLE
  szTransformFile: PAnsiChar;   // LPCSTR
  iReserved1: Integer;   // INT
  iReserved2: Integer   // INT
): DWORD; stdcall;
  external 'msi.dll' name 'MsiDatabaseGenerateTransformA';
result := DllCall("msi\MsiDatabaseGenerateTransformA"
    , "UInt", hDatabase   ; MSIHANDLE
    , "UInt", hDatabaseReference   ; MSIHANDLE
    , "AStr", szTransformFile   ; LPCSTR
    , "Int", iReserved1   ; INT
    , "Int", iReserved2   ; INT
    , "UInt")   ; return: DWORD
●MsiDatabaseGenerateTransformA(hDatabase, hDatabaseReference, szTransformFile, iReserved1, iReserved2) = DLL("msi.dll", "dword MsiDatabaseGenerateTransformA(dword, dword, char*, int, int)")
# 呼び出し: MsiDatabaseGenerateTransformA(hDatabase, hDatabaseReference, szTransformFile, iReserved1, iReserved2)
# hDatabase : MSIHANDLE -> "dword"
# hDatabaseReference : MSIHANDLE -> "dword"
# szTransformFile : LPCSTR -> "char*"
# iReserved1 : INT -> "int"
# iReserved2 : INT -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef MsiDatabaseGenerateTransformANative = Uint32 Function(Uint32, Uint32, Pointer<Utf8>, Int32, Int32);
typedef MsiDatabaseGenerateTransformADart = int Function(int, int, Pointer<Utf8>, int, int);
final MsiDatabaseGenerateTransformA = DynamicLibrary.open('msi.dll')
    .lookupFunction<MsiDatabaseGenerateTransformANative, MsiDatabaseGenerateTransformADart>('MsiDatabaseGenerateTransformA');
// hDatabase : MSIHANDLE -> Uint32
// hDatabaseReference : MSIHANDLE -> Uint32
// szTransformFile : LPCSTR -> Pointer<Utf8>
// iReserved1 : INT -> Int32
// iReserved2 : INT -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function MsiDatabaseGenerateTransformA(
  hDatabase: DWORD;   // MSIHANDLE
  hDatabaseReference: DWORD;   // MSIHANDLE
  szTransformFile: PAnsiChar;   // LPCSTR
  iReserved1: Integer;   // INT
  iReserved2: Integer   // INT
): DWORD; stdcall;
  external 'msi.dll' name 'MsiDatabaseGenerateTransformA';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "MsiDatabaseGenerateTransformA"
  c_MsiDatabaseGenerateTransformA :: Word32 -> Word32 -> CString -> Int32 -> Int32 -> IO Word32
-- hDatabase : MSIHANDLE -> Word32
-- hDatabaseReference : MSIHANDLE -> Word32
-- szTransformFile : LPCSTR -> CString
-- iReserved1 : INT -> Int32
-- iReserved2 : INT -> Int32
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let msidatabasegeneratetransforma =
  foreign "MsiDatabaseGenerateTransformA"
    (uint32_t @-> uint32_t @-> string @-> int32_t @-> int32_t @-> returning uint32_t)
(* hDatabase : MSIHANDLE -> uint32_t *)
(* hDatabaseReference : MSIHANDLE -> uint32_t *)
(* szTransformFile : LPCSTR -> string *)
(* iReserved1 : INT -> int32_t *)
(* iReserved2 : INT -> int32_t *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library msi (t "msi.dll"))
(cffi:use-foreign-library msi)

(cffi:defcfun ("MsiDatabaseGenerateTransformA" msi-database-generate-transform-a :convention :stdcall) :uint32
  (h-database :uint32)   ; MSIHANDLE
  (h-database-reference :uint32)   ; MSIHANDLE
  (sz-transform-file :string)   ; LPCSTR
  (i-reserved1 :int32)   ; INT
  (i-reserved2 :int32))   ; INT
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MsiDatabaseGenerateTransformA = Win32::API::More->new('msi',
    'DWORD MsiDatabaseGenerateTransformA(DWORD hDatabase, DWORD hDatabaseReference, LPCSTR szTransformFile, int iReserved1, int iReserved2)');
# my $ret = $MsiDatabaseGenerateTransformA->Call($hDatabase, $hDatabaseReference, $szTransformFile, $iReserved1, $iReserved2);
# hDatabase : MSIHANDLE -> DWORD
# hDatabaseReference : MSIHANDLE -> DWORD
# szTransformFile : LPCSTR -> LPCSTR
# iReserved1 : INT -> int
# iReserved2 : INT -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

文字セット違い