ホーム › System.ApplicationInstallationAndServicing › MsiBeginTransactionA

MsiBeginTransactionA

関数

複数インストールをまとめるマルチパッケージトランザクションを開始する。

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

シグネチャ

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

DWORD MsiBeginTransactionA(
    LPCSTR szName,
    DWORD dwTransactionAttributes,
    MSIHANDLE* phTransactionHandle,
    HANDLE* phChangeOfOwnerEvent
);

パラメーター

名前

型

方向

説明

szName

LPCSTR

複数パッケージのインストールの名前です。

dwTransactionAttributes

DWORD

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

値	意味
0	0 または値を設定しない場合、Windows Installer は前回のインストールの UI を閉じます。
MSITRANSACTION_CHAIN_EMBEDDEDUI	トランザクションが完了するまで Windows Installer が埋め込み UI をシャットダウンしないように要求するには、この属性を設定します。

phTransactionHandle

MSIHANDLE*

out

トランザクション ID は、トランザクションを識別する MSIHANDLE 値です。1 つのトランザクションを所有できるプロセスは一度に 1 つのみです。

phChangeOfOwnerEvent

HANDLE*

out

このパラメーターは、MsiJoinTransaction 関数がトランザクションの所有者を新しい所有者に変更したときにシグナル状態になるイベントへのハンドルを返します。現在の所有者は、これを使用してトランザクションの所有権が変更されたタイミングを判断できます。トランザクションを所有者のいない状態にすると、トランザクションはロールバックされます。

戻り値の型: DWORD

公式ドキュメント

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

戻り値

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

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

解説(Remarks)

メモ

msi.h ヘッダーは、UNICODE プリプロセッサ定数の定義に基づいて、この関数の ANSI 版または Unicode 版を自動的に選択するエイリアスとして MsiBeginTransaction を定義します。エンコーディング非依存のエイリアスを、エンコーディング非依存ではないコードと混在して使用すると、不一致が生じてコンパイルエラーや実行時エラーを引き起こす可能性があります。詳細については、Conventions for Function Prototypes を参照してください。

出典・ライセンス: 上記「公式ドキュメント」の内容は 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 MsiBeginTransactionA(
    LPCSTR szName,
    DWORD dwTransactionAttributes,
    MSIHANDLE* phTransactionHandle,
    HANDLE* phChangeOfOwnerEvent
);

[DllImport("msi.dll", CharSet = CharSet.Ansi, ExactSpelling = true)]
static extern uint MsiBeginTransactionA(
    [MarshalAs(UnmanagedType.LPStr)] string szName,   // LPCSTR
    uint dwTransactionAttributes,   // DWORD
    out uint phTransactionHandle,   // MSIHANDLE* out
    IntPtr phChangeOfOwnerEvent   // HANDLE* out
);

<DllImport("msi.dll", CharSet:=CharSet.Ansi, ExactSpelling:=True)>
Public Shared Function MsiBeginTransactionA(
    <MarshalAs(UnmanagedType.LPStr)> szName As String,   ' LPCSTR
    dwTransactionAttributes As UInteger,   ' DWORD
    <Out> ByRef phTransactionHandle As UInteger,   ' MSIHANDLE* out
    phChangeOfOwnerEvent As IntPtr   ' HANDLE* out
) As UInteger
End Function

' szName : LPCSTR
' dwTransactionAttributes : DWORD
' phTransactionHandle : MSIHANDLE* out
' phChangeOfOwnerEvent : HANDLE* out
Declare PtrSafe Function MsiBeginTransactionA Lib "msi" ( _
    ByVal szName As String, _
    ByVal dwTransactionAttributes As Long, _
    ByRef phTransactionHandle As Long, _
    ByVal phChangeOfOwnerEvent As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

MsiBeginTransactionA = ctypes.windll.msi.MsiBeginTransactionA
MsiBeginTransactionA.restype = wintypes.DWORD
MsiBeginTransactionA.argtypes = [
    wintypes.LPCSTR,  # szName : LPCSTR
    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')
MsiBeginTransactionA = Fiddle::Function.new(
  lib['MsiBeginTransactionA'],
  [
    Fiddle::TYPE_VOIDP,  # szName : LPCSTR
    -Fiddle::TYPE_INT,  # dwTransactionAttributes : DWORD
    Fiddle::TYPE_VOIDP,  # phTransactionHandle : MSIHANDLE* out
    Fiddle::TYPE_VOIDP,  # phChangeOfOwnerEvent : HANDLE* out
  ],
  -Fiddle::TYPE_INT)

#[link(name = "msi")]
extern "system" {
    fn MsiBeginTransactionA(
        szName: *const u8,  // LPCSTR
        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.Ansi)]
public static extern uint MsiBeginTransactionA([MarshalAs(UnmanagedType.LPStr)] string szName, uint dwTransactionAttributes, out uint phTransactionHandle, IntPtr phChangeOfOwnerEvent);
"@
$api = Add-Type -MemberDefinition $sig -Name 'msi_MsiBeginTransactionA' -Namespace Win32 -PassThru
# $api::MsiBeginTransactionA(szName, dwTransactionAttributes, phTransactionHandle, phChangeOfOwnerEvent)

#uselib "msi.dll"
#func global MsiBeginTransactionA "MsiBeginTransactionA" sptr, sptr, sptr, sptr
; MsiBeginTransactionA szName, dwTransactionAttributes, varptr(phTransactionHandle), phChangeOfOwnerEvent   ; 戻り値は stat
; szName : LPCSTR -> "sptr"
; dwTransactionAttributes : DWORD -> "sptr"
; phTransactionHandle : MSIHANDLE* out -> "sptr"
; phChangeOfOwnerEvent : HANDLE* out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "msi.dll"
#cfunc global MsiBeginTransactionA "MsiBeginTransactionA" str, int, var, sptr
; res = MsiBeginTransactionA(szName, dwTransactionAttributes, phTransactionHandle, phChangeOfOwnerEvent)
; szName : LPCSTR -> "str"
; dwTransactionAttributes : DWORD -> "int"
; phTransactionHandle : MSIHANDLE* out -> "var"
; phChangeOfOwnerEvent : HANDLE* out -> "sptr"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "msi.dll"
#cfunc global MsiBeginTransactionA "MsiBeginTransactionA" str, int, sptr, sptr
; res = MsiBeginTransactionA(szName, dwTransactionAttributes, varptr(phTransactionHandle), phChangeOfOwnerEvent)
; szName : LPCSTR -> "str"
; dwTransactionAttributes : DWORD -> "int"
; phTransactionHandle : MSIHANDLE* out -> "sptr"
; phChangeOfOwnerEvent : HANDLE* out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。