ホーム › System.ApplicationInstallationAndServicing › MsiDatabaseGenerateTransformW

MsiDatabaseGenerateTransformW

関数

2つのデータベースの差分からトランスフォームファイルを生成する。

DLLmsi.dll文字セットUnicode (-W)呼出規約winapi対応OSwindows8.0

シグネチャ

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

DWORD MsiDatabaseGenerateTransformW(
    MSIHANDLE hDatabase,
    MSIHANDLE hDatabaseReference,
    LPCWSTR szTransformFile,
    INT iReserved1,
    INT iReserved2
);

パラメーター

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

戻り値の型: DWORD

公式ドキュメント

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

戻り値

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  (Unicode / -W)
#include <windows.h>

DWORD MsiDatabaseGenerateTransformW(
    MSIHANDLE hDatabase,
    MSIHANDLE hDatabaseReference,
    LPCWSTR szTransformFile,
    INT iReserved1,
    INT iReserved2
);

[DllImport("msi.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint MsiDatabaseGenerateTransformW(
    uint hDatabase,   // MSIHANDLE
    uint hDatabaseReference,   // MSIHANDLE
    [MarshalAs(UnmanagedType.LPWStr)] string szTransformFile,   // LPCWSTR
    int iReserved1,   // INT
    int iReserved2   // INT
);

<DllImport("msi.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function MsiDatabaseGenerateTransformW(
    hDatabase As UInteger,   ' MSIHANDLE
    hDatabaseReference As UInteger,   ' MSIHANDLE
    <MarshalAs(UnmanagedType.LPWStr)> szTransformFile As String,   ' LPCWSTR
    iReserved1 As Integer,   ' INT
    iReserved2 As Integer   ' INT
) As UInteger
End Function

' hDatabase : MSIHANDLE
' hDatabaseReference : MSIHANDLE
' szTransformFile : LPCWSTR
' iReserved1 : INT
' iReserved2 : INT
Declare PtrSafe Function MsiDatabaseGenerateTransformW Lib "msi" ( _
    ByVal hDatabase As Long, _
    ByVal hDatabaseReference As Long, _
    ByVal szTransformFile As LongPtr, _
    ByVal iReserved1 As Long, _
    ByVal iReserved2 As Long) 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

MsiDatabaseGenerateTransformW = ctypes.windll.msi.MsiDatabaseGenerateTransformW
MsiDatabaseGenerateTransformW.restype = wintypes.DWORD
MsiDatabaseGenerateTransformW.argtypes = [
    wintypes.DWORD,  # hDatabase : MSIHANDLE
    wintypes.DWORD,  # hDatabaseReference : MSIHANDLE
    wintypes.LPCWSTR,  # szTransformFile : LPCWSTR
    ctypes.c_int,  # iReserved1 : INT
    ctypes.c_int,  # iReserved2 : INT
]

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('msi.dll')
MsiDatabaseGenerateTransformW = Fiddle::Function.new(
  lib['MsiDatabaseGenerateTransformW'],
  [
    -Fiddle::TYPE_INT,  # hDatabase : MSIHANDLE
    -Fiddle::TYPE_INT,  # hDatabaseReference : MSIHANDLE
    Fiddle::TYPE_VOIDP,  # szTransformFile : LPCWSTR
    Fiddle::TYPE_INT,  # iReserved1 : INT
    Fiddle::TYPE_INT,  # iReserved2 : INT
  ],
  -Fiddle::TYPE_INT)
# Wide strings: pass str.encode("UTF-16LE") + "\x00\x00"

#[link(name = "msi")]
extern "system" {
    fn MsiDatabaseGenerateTransformW(
        hDatabase: u32,  // MSIHANDLE
        hDatabaseReference: u32,  // MSIHANDLE
        szTransformFile: *const u16,  // LPCWSTR
        iReserved1: i32,  // INT
        iReserved2: i32  // INT
    ) -> u32;
}
// crates: windows-sys provides ready-made bindings for this API.

$sig = @"
[DllImport("msi.dll", CharSet = CharSet.Unicode)]
public static extern uint MsiDatabaseGenerateTransformW(uint hDatabase, uint hDatabaseReference, [MarshalAs(UnmanagedType.LPWStr)] string szTransformFile, int iReserved1, int iReserved2);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiDatabaseGenerateTransformW' -Namespace Win32 -PassThru
# $api::MsiDatabaseGenerateTransformW(hDatabase, hDatabaseReference, szTransformFile, iReserved1, iReserved2)

#uselib "msi.dll"
#func global MsiDatabaseGenerateTransformW "MsiDatabaseGenerateTransformW" wptr, wptr, wptr, wptr, wptr
; MsiDatabaseGenerateTransformW hDatabase, hDatabaseReference, szTransformFile, iReserved1, iReserved2   ; 戻り値は stat
; hDatabase : MSIHANDLE -> "wptr"
; hDatabaseReference : MSIHANDLE -> "wptr"
; szTransformFile : LPCWSTR -> "wptr"
; iReserved1 : INT -> "wptr"
; iReserved2 : INT -> "wptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

#uselib "msi.dll"
#cfunc global MsiDatabaseGenerateTransformW "MsiDatabaseGenerateTransformW" int, int, wstr, int, int
; res = MsiDatabaseGenerateTransformW(hDatabase, hDatabaseReference, szTransformFile, iReserved1, iReserved2)
; hDatabase : MSIHANDLE -> "int"
; hDatabaseReference : MSIHANDLE -> "int"
; szTransformFile : LPCWSTR -> "wstr"
; iReserved1 : INT -> "int"
; iReserved2 : INT -> "int"

; DWORD MsiDatabaseGenerateTransformW(MSIHANDLE hDatabase, MSIHANDLE hDatabaseReference, LPCWSTR szTransformFile, INT iReserved1, INT iReserved2)
#uselib "msi.dll"
#cfunc global MsiDatabaseGenerateTransformW "MsiDatabaseGenerateTransformW" int, int, wstr, int, int
; res = MsiDatabaseGenerateTransformW(hDatabase, hDatabaseReference, szTransformFile, iReserved1, iReserved2)
; hDatabase : MSIHANDLE -> "int"
; hDatabaseReference : MSIHANDLE -> "int"
; szTransformFile : LPCWSTR -> "wstr"
; iReserved1 : INT -> "int"
; iReserved2 : INT -> "int"

import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	msi = windows.NewLazySystemDLL("msi.dll")
	procMsiDatabaseGenerateTransformW = msi.NewProc("MsiDatabaseGenerateTransformW")
)

// hDatabase (MSIHANDLE), hDatabaseReference (MSIHANDLE), szTransformFile (LPCWSTR), iReserved1 (INT), iReserved2 (INT)
r1, _, err := procMsiDatabaseGenerateTransformW.Call(
	uintptr(hDatabase),
	uintptr(hDatabaseReference),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(szTransformFile))),
	uintptr(iReserved1),
	uintptr(iReserved2),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD

function MsiDatabaseGenerateTransformW(
  hDatabase: DWORD;   // MSIHANDLE
  hDatabaseReference: DWORD;   // MSIHANDLE
  szTransformFile: PWideChar;   // LPCWSTR
  iReserved1: Integer;   // INT
  iReserved2: Integer   // INT
): DWORD; stdcall;
  external 'msi.dll' name 'MsiDatabaseGenerateTransformW';

result := DllCall("msi\MsiDatabaseGenerateTransformW"
    , "UInt", hDatabase   ; MSIHANDLE
    , "UInt", hDatabaseReference   ; MSIHANDLE
    , "WStr", szTransformFile   ; LPCWSTR
    , "Int", iReserved1   ; INT
    , "Int", iReserved2   ; INT
    , "UInt")   ; return: DWORD

●MsiDatabaseGenerateTransformW(hDatabase, hDatabaseReference, szTransformFile, iReserved1, iReserved2) = DLL("msi.dll", "dword MsiDatabaseGenerateTransformW(dword, dword, char*, int, int)")
# 呼び出し: MsiDatabaseGenerateTransformW(hDatabase, hDatabaseReference, szTransformFile, iReserved1, iReserved2)
# hDatabase : MSIHANDLE -> "dword"
# hDatabaseReference : MSIHANDLE -> "dword"
# szTransformFile : LPCWSTR -> "char*"
# iReserved1 : INT -> "int"
# iReserved2 : INT -> "int"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。

const std = @import("std");

extern "msi" fn MsiDatabaseGenerateTransformW(
    hDatabase: u32, // MSIHANDLE
    hDatabaseReference: u32, // MSIHANDLE
    szTransformFile: [*c]const u16, // LPCWSTR
    iReserved1: i32, // INT
    iReserved2: i32 // INT
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。

proc MsiDatabaseGenerateTransformW(
    hDatabase: uint32,  # MSIHANDLE
    hDatabaseReference: uint32,  # MSIHANDLE
    szTransformFile: WideCString,  # LPCWSTR
    iReserved1: int32,  # INT
    iReserved2: int32  # INT
): uint32 {.importc: "MsiDatabaseGenerateTransformW", stdcall, dynlib: "msi.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。

pragma(lib, "msi");
extern(Windows)
uint MsiDatabaseGenerateTransformW(
    uint hDatabase,   // MSIHANDLE
    uint hDatabaseReference,   // MSIHANDLE
    const(wchar)* szTransformFile,   // LPCWSTR
    int iReserved1,   // INT
    int iReserved2   // INT
);

ccall((:MsiDatabaseGenerateTransformW, "msi.dll"), stdcall, UInt32,
      (UInt32, UInt32, Cwstring, Int32, Int32),
      hDatabase, hDatabaseReference, szTransformFile, iReserved1, iReserved2)
# hDatabase : MSIHANDLE -> UInt32
# hDatabaseReference : MSIHANDLE -> UInt32
# szTransformFile : LPCWSTR -> Cwstring
# iReserved1 : INT -> Int32
# iReserved2 : INT -> Int32
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。

local ffi = require("ffi")
ffi.cdef[[
uint32_t MsiDatabaseGenerateTransformW(
    uint32_t hDatabase,
    uint32_t hDatabaseReference,
    const uint16_t* szTransformFile,
    int32_t iReserved1,
    int32_t iReserved2);
]]
local msi = ffi.load("msi")
-- msi.MsiDatabaseGenerateTransformW(hDatabase, hDatabaseReference, szTransformFile, iReserved1, iReserved2)
-- hDatabase : MSIHANDLE
-- hDatabaseReference : MSIHANDLE
-- szTransformFile : LPCWSTR
-- iReserved1 : INT
-- iReserved2 : INT
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
-- Unicode(-W): uint16_t* には UTF-16LE のバッファ(ffi.new("uint16_t[?]", ...))を渡す。

const koffi = require('koffi');
const lib = koffi.load('msi.dll');
const MsiDatabaseGenerateTransformW = lib.func('__stdcall', 'MsiDatabaseGenerateTransformW', 'uint32_t', ['uint32_t', 'uint32_t', 'str16', 'int32_t', 'int32_t']);
// MsiDatabaseGenerateTransformW(hDatabase, hDatabaseReference, szTransformFile, iReserved1, iReserved2)
// hDatabase : MSIHANDLE -> 'uint32_t'
// hDatabaseReference : MSIHANDLE -> 'uint32_t'
// szTransformFile : LPCWSTR -> 'str16'
// iReserved1 : INT -> 'int32_t'
// iReserved2 : INT -> 'int32_t'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。

const lib = Deno.dlopen("msi.dll", {
  MsiDatabaseGenerateTransformW: { parameters: ["u32", "u32", "buffer", "i32", "i32"], result: "u32" },
});
// lib.symbols.MsiDatabaseGenerateTransformW(hDatabase, hDatabaseReference, szTransformFile, iReserved1, iReserved2)
// hDatabase : MSIHANDLE -> "u32"
// hDatabaseReference : MSIHANDLE -> "u32"
// szTransformFile : LPCWSTR -> "buffer"
// iReserved1 : INT -> "i32"
// iReserved2 : INT -> "i32"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。

<?php
$ffi = FFI::cdef(<<<C
uint32_t MsiDatabaseGenerateTransformW(
    uint32_t hDatabase,
    uint32_t hDatabaseReference,
    const uint16_t* szTransformFile,
    int32_t iReserved1,
    int32_t iReserved2);
C, "msi.dll");
// $ffi->MsiDatabaseGenerateTransformW(hDatabase, hDatabaseReference, szTransformFile, iReserved1, iReserved2);
// hDatabase : MSIHANDLE
// hDatabaseReference : MSIHANDLE
// szTransformFile : LPCWSTR
// 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.UNICODE_OPTIONS);
    int MsiDatabaseGenerateTransformW(
        int hDatabase,   // MSIHANDLE
        int hDatabaseReference,   // MSIHANDLE
        WString szTransformFile,   // LPCWSTR
        int iReserved1,   // INT
        int iReserved2   // INT
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。

@[Link("msi")]
lib Libmsi
  fun MsiDatabaseGenerateTransformW = MsiDatabaseGenerateTransformW(
    hDatabase : UInt32,   # MSIHANDLE
    hDatabaseReference : UInt32,   # MSIHANDLE
    szTransformFile : UInt16*,   # LPCWSTR
    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 MsiDatabaseGenerateTransformWNative = Uint32 Function(Uint32, Uint32, Pointer<Utf16>, Int32, Int32);
typedef MsiDatabaseGenerateTransformWDart = int Function(int, int, Pointer<Utf16>, int, int);
final MsiDatabaseGenerateTransformW = DynamicLibrary.open('msi.dll')
    .lookupFunction<MsiDatabaseGenerateTransformWNative, MsiDatabaseGenerateTransformWDart>('MsiDatabaseGenerateTransformW');
// hDatabase : MSIHANDLE -> Uint32
// hDatabaseReference : MSIHANDLE -> Uint32
// szTransformFile : LPCWSTR -> Pointer<Utf16>
// iReserved1 : INT -> Int32
// iReserved2 : INT -> Int32
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。

{$mode objfpc}{$H+}
function MsiDatabaseGenerateTransformW(
  hDatabase: DWORD;   // MSIHANDLE
  hDatabaseReference: DWORD;   // MSIHANDLE
  szTransformFile: PWideChar;   // LPCWSTR
  iReserved1: Integer;   // INT
  iReserved2: Integer   // INT
): DWORD; stdcall;
  external 'msi.dll' name 'MsiDatabaseGenerateTransformW';

import Foreign
import Foreign.C.Types
import Foreign.C.String

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

open Ctypes
open Foreign

let msidatabasegeneratetransformw =
  foreign "MsiDatabaseGenerateTransformW"
    (uint32_t @-> uint32_t @-> (ptr uint16_t) @-> int32_t @-> int32_t @-> returning uint32_t)
(* hDatabase : MSIHANDLE -> uint32_t *)
(* hDatabaseReference : MSIHANDLE -> uint32_t *)
(* szTransformFile : LPCWSTR -> (ptr uint16_t) *)
(* 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 ("MsiDatabaseGenerateTransformW" msi-database-generate-transform-w :convention :stdcall) :uint32
  (h-database :uint32)   ; MSIHANDLE
  (h-database-reference :uint32)   ; MSIHANDLE
  (sz-transform-file (:string :encoding :utf-16le))   ; LPCWSTR
  (i-reserved1 :int32)   ; INT
  (i-reserved2 :int32))   ; INT
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。

use Win32::API;
my $MsiDatabaseGenerateTransformW = Win32::API::More->new('msi',
    'DWORD MsiDatabaseGenerateTransformW(DWORD hDatabase, DWORD hDatabaseReference, LPCWSTR szTransformFile, int iReserved1, int iReserved2)');
# my $ret = $MsiDatabaseGenerateTransformW->Call($hDatabase, $hDatabaseReference, $szTransformFile, $iReserved1, $iReserved2);
# hDatabase : MSIHANDLE -> DWORD
# hDatabaseReference : MSIHANDLE -> DWORD
# szTransformFile : LPCWSTR -> LPCWSTR
# iReserved1 : INT -> int
# iReserved2 : INT -> int
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。