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

MsiBeginTransactionW

関数
複数インストールをまとめるマルチパッケージトランザクションを開始する。
DLLmsi.dll文字セットUnicode (-W)呼出規約winapi対応OSwindows8.0

シグネチャ

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

DWORD MsiBeginTransactionW(
    LPCWSTR szName,
    DWORD dwTransactionAttributes,
    MSIHANDLE* phTransactionHandle,
    HANDLE* phChangeOfOwnerEvent
);

パラメーター

名前方向説明
szNameLPCWSTRin複数パッケージのインストールの名前。
dwTransactionAttributesDWORDin

複数パッケージのインストールの属性。

意味
0
0 または値が設定されていない場合、Windows Installer は前回のインストールの UI を閉じます。
MSITRANSACTION_CHAIN_EMBEDDEDUI
トランザクションが完了するまで Windows Installer が埋め込み UI をシャットダウンしないように要求するには、この属性を設定します。
phTransactionHandleMSIHANDLE*outトランザクション ID は、トランザクションを識別する MSIHANDLE 値です。1 つのトランザクションを所有できるプロセスは、一度に 1 つだけです。
phChangeOfOwnerEventHANDLE*outこのパラメーターは、MsiJoinTransaction 関数がトランザクションの所有者を新しい所有者に変更したときにシグナル状態になるイベントのハンドルを返します。現在の所有者は、これを使用してトランザクションの所有権が変更されたタイミングを判断できます。所有者のいない状態のままトランザクションを放置すると、トランザクションはロールバックされます。

戻り値の型: DWORD

公式ドキュメント

MsiBeginTransaction 関数は、複数パッケージのインストールのトランザクション処理を開始し、そのトランザクションの識別子を返します。(Unicode)

戻り値

MsiBeginTransaction 関数は、次の値を返します。

意味
ERROR_INSTALL_SERVICE_FAILURE
インストール サービスにアクセスできませんでした。この関数には Windows Installer サービスが必要です。
ERROR_INSTALL_ALREADY_RUNNING
システム上で一度に開けるトランザクションは 1 つだけです。別のトランザクションの実行中にこの関数が呼び出された場合、このエラーが返されます。
ERROR_INVALID_PARAMETER
無効なパラメーターが関数に渡されました。
ERROR_ROLLBACK_DISABLED

DISABLEROLLBACK プロパティまたは DisableRollback ポリシーによって ロールバック インストール が無効化されています。

解説(Remarks)

メモ

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

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 MsiBeginTransactionW(
    LPCWSTR szName,
    DWORD dwTransactionAttributes,
    MSIHANDLE* phTransactionHandle,
    HANDLE* phChangeOfOwnerEvent
);
[DllImport("msi.dll", CharSet = CharSet.Unicode, ExactSpelling = true)]
static extern uint MsiBeginTransactionW(
    [MarshalAs(UnmanagedType.LPWStr)] string szName,   // LPCWSTR
    uint dwTransactionAttributes,   // DWORD
    out uint phTransactionHandle,   // MSIHANDLE* out
    IntPtr phChangeOfOwnerEvent   // HANDLE* out
);
<DllImport("msi.dll", CharSet:=CharSet.Unicode, ExactSpelling:=True)>
Public Shared Function MsiBeginTransactionW(
    <MarshalAs(UnmanagedType.LPWStr)> szName As String,   ' LPCWSTR
    dwTransactionAttributes As UInteger,   ' DWORD
    <Out> ByRef phTransactionHandle As UInteger,   ' MSIHANDLE* out
    phChangeOfOwnerEvent As IntPtr   ' HANDLE* out
) As UInteger
End Function
' szName : LPCWSTR
' dwTransactionAttributes : DWORD
' phTransactionHandle : MSIHANDLE* out
' phChangeOfOwnerEvent : HANDLE* out
Declare PtrSafe Function MsiBeginTransactionW Lib "msi" ( _
    ByVal szName As LongPtr, _
    ByVal dwTransactionAttributes As Long, _
    ByRef phTransactionHandle As Long, _
    ByVal phChangeOfOwnerEvent 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

MsiBeginTransactionW = ctypes.windll.msi.MsiBeginTransactionW
MsiBeginTransactionW.restype = wintypes.DWORD
MsiBeginTransactionW.argtypes = [
    wintypes.LPCWSTR,  # szName : LPCWSTR
    wintypes.DWORD,  # dwTransactionAttributes : DWORD
    ctypes.c_void_p,  # phTransactionHandle : MSIHANDLE* out
    ctypes.c_void_p,  # phChangeOfOwnerEvent : HANDLE* out
]
require 'fiddle'
require 'fiddle/import'

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

var (
	msi = windows.NewLazySystemDLL("msi.dll")
	procMsiBeginTransactionW = msi.NewProc("MsiBeginTransactionW")
)

// szName (LPCWSTR), dwTransactionAttributes (DWORD), phTransactionHandle (MSIHANDLE* out), phChangeOfOwnerEvent (HANDLE* out)
r1, _, err := procMsiBeginTransactionW.Call(
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(szName))),
	uintptr(dwTransactionAttributes),
	uintptr(phTransactionHandle),
	uintptr(phChangeOfOwnerEvent),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // DWORD
function MsiBeginTransactionW(
  szName: PWideChar;   // LPCWSTR
  dwTransactionAttributes: DWORD;   // DWORD
  phTransactionHandle: Pointer;   // MSIHANDLE* out
  phChangeOfOwnerEvent: Pointer   // HANDLE* out
): DWORD; stdcall;
  external 'msi.dll' name 'MsiBeginTransactionW';
result := DllCall("msi\MsiBeginTransactionW"
    , "WStr", szName   ; LPCWSTR
    , "UInt", dwTransactionAttributes   ; DWORD
    , "Ptr", phTransactionHandle   ; MSIHANDLE* out
    , "Ptr", phChangeOfOwnerEvent   ; HANDLE* out
    , "UInt")   ; return: DWORD
●MsiBeginTransactionW(szName, dwTransactionAttributes, phTransactionHandle, phChangeOfOwnerEvent) = DLL("msi.dll", "dword MsiBeginTransactionW(char*, dword, void*, void*)")
# 呼び出し: MsiBeginTransactionW(szName, dwTransactionAttributes, phTransactionHandle, phChangeOfOwnerEvent)
# szName : LPCWSTR -> "char*"
# dwTransactionAttributes : DWORD -> "dword"
# phTransactionHandle : MSIHANDLE* out -> "void*"
# phChangeOfOwnerEvent : HANDLE* out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
# ※-W(Unicode)関数。なでしこ1はANSIのため -A 版の利用を推奨。
const std = @import("std");

extern "msi" fn MsiBeginTransactionW(
    szName: [*c]const u16, // LPCWSTR
    dwTransactionAttributes: u32, // DWORD
    phTransactionHandle: [*c]u32, // MSIHANDLE* out
    phChangeOfOwnerEvent: ?*anyopaque // HANDLE* out
) callconv(std.os.windows.WINAPI) u32;
// Unicode(-W): UTF-16LE のヌル終端バッファ([*c]const u16)を渡す。
proc MsiBeginTransactionW(
    szName: WideCString,  # LPCWSTR
    dwTransactionAttributes: uint32,  # DWORD
    phTransactionHandle: ptr uint32,  # MSIHANDLE* out
    phChangeOfOwnerEvent: pointer  # HANDLE* out
): uint32 {.importc: "MsiBeginTransactionW", stdcall, dynlib: "msi.dll".}
# Unicode(-W): WideCString は newWideCString("...") で生成。
pragma(lib, "msi");
extern(Windows)
uint MsiBeginTransactionW(
    const(wchar)* szName,   // LPCWSTR
    uint dwTransactionAttributes,   // DWORD
    uint* phTransactionHandle,   // MSIHANDLE* out
    void* phChangeOfOwnerEvent   // HANDLE* out
);
ccall((:MsiBeginTransactionW, "msi.dll"), stdcall, UInt32,
      (Cwstring, UInt32, Ptr{UInt32}, Ptr{Cvoid}),
      szName, dwTransactionAttributes, phTransactionHandle, phChangeOfOwnerEvent)
# szName : LPCWSTR -> Cwstring
# dwTransactionAttributes : DWORD -> UInt32
# phTransactionHandle : MSIHANDLE* out -> Ptr{UInt32}
# phChangeOfOwnerEvent : HANDLE* out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
# Unicode(-W): Cwstring には transcode(UInt16, "...") 等で UTF-16 を渡す。
local ffi = require("ffi")
ffi.cdef[[
uint32_t MsiBeginTransactionW(
    const uint16_t* szName,
    uint32_t dwTransactionAttributes,
    uint32_t* phTransactionHandle,
    void* phChangeOfOwnerEvent);
]]
local msi = ffi.load("msi")
-- msi.MsiBeginTransactionW(szName, dwTransactionAttributes, phTransactionHandle, phChangeOfOwnerEvent)
-- szName : LPCWSTR
-- dwTransactionAttributes : DWORD
-- phTransactionHandle : MSIHANDLE* out
-- phChangeOfOwnerEvent : HANDLE* out
-- 構造体/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 MsiBeginTransactionW = lib.func('__stdcall', 'MsiBeginTransactionW', 'uint32_t', ['str16', 'uint32_t', 'uint32_t *', 'void *']);
// MsiBeginTransactionW(szName, dwTransactionAttributes, phTransactionHandle, phChangeOfOwnerEvent)
// szName : LPCWSTR -> 'str16'
// dwTransactionAttributes : DWORD -> 'uint32_t'
// phTransactionHandle : MSIHANDLE* out -> 'uint32_t *'
// phChangeOfOwnerEvent : HANDLE* out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("msi.dll", {
  MsiBeginTransactionW: { parameters: ["buffer", "u32", "pointer", "pointer"], result: "u32" },
});
// lib.symbols.MsiBeginTransactionW(szName, dwTransactionAttributes, phTransactionHandle, phChangeOfOwnerEvent)
// szName : LPCWSTR -> "buffer"
// dwTransactionAttributes : DWORD -> "u32"
// phTransactionHandle : MSIHANDLE* out -> "pointer"
// phChangeOfOwnerEvent : HANDLE* out -> "pointer"
// 文字列は "buffer"。Unicode(-W) は new TextEncoder() ではなく UTF-16LE のバイト列(末尾に \x00\x00)を Uint8Array で渡す。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t MsiBeginTransactionW(
    const uint16_t* szName,
    uint32_t dwTransactionAttributes,
    uint32_t* phTransactionHandle,
    void* phChangeOfOwnerEvent);
C, "msi.dll");
// $ffi->MsiBeginTransactionW(szName, dwTransactionAttributes, phTransactionHandle, phChangeOfOwnerEvent);
// szName : LPCWSTR
// dwTransactionAttributes : DWORD
// phTransactionHandle : MSIHANDLE* out
// phChangeOfOwnerEvent : HANDLE* 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.UNICODE_OPTIONS);
    int MsiBeginTransactionW(
        WString szName,   // LPCWSTR
        int dwTransactionAttributes,   // DWORD
        IntByReference phTransactionHandle,   // MSIHANDLE* out
        Pointer phChangeOfOwnerEvent   // HANDLE* out
    );
}
// Unicode(-W): WString(入力)/char[](出力)で UTF-16 をマーシャリング。
@[Link("msi")]
lib Libmsi
  fun MsiBeginTransactionW = MsiBeginTransactionW(
    szName : UInt16*,   # LPCWSTR
    dwTransactionAttributes : UInt32,   # DWORD
    phTransactionHandle : UInt32*,   # MSIHANDLE* out
    phChangeOfOwnerEvent : Void*   # HANDLE* out
  ) : UInt32
end
# 構造体/GUID/enum は lib 内に対応する型定義が必要。
# 呼出規約: x64 は規約統一のため OK。x86(32bit)は WINAPI=stdcall だが Crystal の fun に stdcall 付与構文がなく非対応。
import 'dart:ffi';
import 'package:ffi/ffi.dart';

typedef MsiBeginTransactionWNative = Uint32 Function(Pointer<Utf16>, Uint32, Pointer<Uint32>, Pointer<Void>);
typedef MsiBeginTransactionWDart = int Function(Pointer<Utf16>, int, Pointer<Uint32>, Pointer<Void>);
final MsiBeginTransactionW = DynamicLibrary.open('msi.dll')
    .lookupFunction<MsiBeginTransactionWNative, MsiBeginTransactionWDart>('MsiBeginTransactionW');
// szName : LPCWSTR -> Pointer<Utf16>
// dwTransactionAttributes : DWORD -> Uint32
// phTransactionHandle : MSIHANDLE* out -> Pointer<Uint32>
// phChangeOfOwnerEvent : HANDLE* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function MsiBeginTransactionW(
  szName: PWideChar;   // LPCWSTR
  dwTransactionAttributes: DWORD;   // DWORD
  phTransactionHandle: Pointer;   // MSIHANDLE* out
  phChangeOfOwnerEvent: Pointer   // HANDLE* out
): DWORD; stdcall;
  external 'msi.dll' name 'MsiBeginTransactionW';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "MsiBeginTransactionW"
  c_MsiBeginTransactionW :: CWString -> Word32 -> Ptr Word32 -> Ptr () -> IO Word32
-- szName : LPCWSTR -> CWString
-- dwTransactionAttributes : DWORD -> Word32
-- phTransactionHandle : MSIHANDLE* out -> Ptr Word32
-- phChangeOfOwnerEvent : HANDLE* out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let msibegintransactionw =
  foreign "MsiBeginTransactionW"
    ((ptr uint16_t) @-> uint32_t @-> (ptr uint32_t) @-> (ptr void) @-> returning uint32_t)
(* szName : LPCWSTR -> (ptr uint16_t) *)
(* dwTransactionAttributes : DWORD -> uint32_t *)
(* phTransactionHandle : MSIHANDLE* out -> (ptr uint32_t) *)
(* phChangeOfOwnerEvent : HANDLE* out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library msi (t "msi.dll"))
(cffi:use-foreign-library msi)

(cffi:defcfun ("MsiBeginTransactionW" msi-begin-transaction-w :convention :stdcall) :uint32
  (sz-name (:string :encoding :utf-16le))   ; LPCWSTR
  (dw-transaction-attributes :uint32)   ; DWORD
  (ph-transaction-handle :pointer)   ; MSIHANDLE* out
  (ph-change-of-owner-event :pointer))   ; HANDLE* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MsiBeginTransactionW = Win32::API::More->new('msi',
    'DWORD MsiBeginTransactionW(LPCWSTR szName, DWORD dwTransactionAttributes, LPVOID phTransactionHandle, HANDLE phChangeOfOwnerEvent)');
# my $ret = $MsiBeginTransactionW->Call($szName, $dwTransactionAttributes, $phTransactionHandle, $phChangeOfOwnerEvent);
# szName : LPCWSTR -> LPCWSTR
# dwTransactionAttributes : DWORD -> DWORD
# phTransactionHandle : MSIHANDLE* out -> LPVOID
# phChangeOfOwnerEvent : HANDLE* out -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。
# Unicode(-W): LPCWSTR/LPWSTR は Win32::API が UTF-16 変換を行う。

関連項目

文字セット違い