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

MsiEndTransaction

関数
進行中のインストールトランザクションをコミットまたはロールバックして終了する。
DLLmsi.dll呼出規約winapi対応OSwindows8.0

シグネチャ

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

DWORD MsiEndTransaction(
    MSITRANSACTIONSTATE dwTransactionState
);

パラメーター

名前方向説明
dwTransactionStateMSITRANSACTIONSTATEin

このパラメーターの値によって、インストーラーがトランザクションに属するすべてのインストールをコミットするかロールバックするかが決まります。値は次のいずれかを指定できます。

意味
MSITRANSACTIONSTATE_ROLLBACK
Rollback Installation を実行し、MsiBeginTransaction 関数によって開始されたトランザクションに属するシステムへの変更を元に戻します。
MSITRANSACTIONSTATE_COMMIT
トランザクションに属するシステムへのすべての変更をコミットします。Commit Custom Actions を実行し、Win32 または共通言語ランタイムのアセンブリへの変更をシステムにコミットします。ロールバックスクリプトを削除します。このオプションを使用した後は、Rollback Installation によってトランザクションの変更を元に戻すことはできなくなります。

戻り値の型: DWORD

公式ドキュメント

MsiEndTransaction 関数は、MsiBeginTransaction 関数によって開始されたトランザクションに属するすべてのインストールをコミットまたはロールバックできます。

戻り値

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

意味
ERROR_ACCESS_DENIED
トランザクションは現在の所有者のみが終了できます。
ERROR_INSTALL_FAILURE
トランザクションに属するインストールを完了できませんでした。
ERROR_INSTALL_ALREADY_RUNNING
トランザクションに属するインストールがまだ進行中です。
ERROR_ROLLBACK_DISABLED
トランザクションに属するインストールが完了しませんでした。インストール中に DisableRollback アクションがパッケージの rollback installations を無効にしました。インストーラーはロールバックが無効になった時点までインストールをロールバックし、この関数はこのエラーを返します。
出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

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

MsiEndTransaction = ctypes.windll.msi.MsiEndTransaction
MsiEndTransaction.restype = wintypes.DWORD
MsiEndTransaction.argtypes = [
    wintypes.DWORD,  # dwTransactionState : MSITRANSACTIONSTATE
]
require 'fiddle'
require 'fiddle/import'

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

var (
	msi = windows.NewLazySystemDLL("msi.dll")
	procMsiEndTransaction = msi.NewProc("MsiEndTransaction")
)

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

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

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

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

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

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

関連項目

使用する型