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

MsiJoinTransaction

関数
既存のインストールトランザクションに現在のセッションを参加させる。
DLLmsi.dll呼出規約winapi対応OSwindows8.0

シグネチャ

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

DWORD MsiJoinTransaction(
    MSIHANDLE hTransactionHandle,
    DWORD dwTransactionAttributes,
    HANDLE* phChangeOfOwnerEvent
);

パラメーター

名前方向説明
hTransactionHandleMSIHANDLEinトランザクション ID。トランザクションを識別する値で、MsiBeginTransaction 関数によって返される識別子です。
dwTransactionAttributesDWORDin

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

意味
0
0 または値が設定されていない場合、Windows インストーラーは前のインストールの UI を閉じます。
MSITRANSACTION_CHAIN_EMBEDDEDUI
トランザクションが完了するまで、Windows インストーラーが組み込み UI をシャットダウンしないよう要求するには、この属性を設定します。
MSITRANSACTION_JOIN_EXISTING_EMBEDDEDUI
元のインストールから組み込み UI を引き継ぐよう Windows インストーラーに要求するには、この属性を設定します。元のインストールに組み込み UI がない場合、この属性を設定しても何も起こりません。
phChangeOfOwnerEventHANDLE*outこのパラメーターは、MsiJoinTransaction 関数がトランザクションの所有者を新しい所有者に変更したときにシグナル状態になるイベントのハンドルを返します。現在の所有者はこれを使用して、トランザクションの所有権がいつ変更されたかを判別できます。トランザクションを所有者のない状態のままにすると、トランザクションはロールバックされます。

戻り値の型: DWORD

公式ドキュメント

MsiJoinTransaction 関数は、複数パッケージのインストールを実行しているトランザクションの所有者を、現在のプロセスにするよう Windows インストーラーに要求します。

戻り値

MsiJoinTransaction 関数は次の値を返すことがあります。

意味
ERROR_ACCESS_DENIED
トランザクションを所有するユーザーと、トランザクションに参加するユーザーが同一ではありません。
ERROR_INVALID_PARAMETER
無効なパラメーターが関数に渡されました。
ERROR_INSTALL_ALREADY_RUNNING
アクティブなインストールの進行中は、所有者を変更できません。
ERROR_INVALID_HANDLE_STATE
指定されたトランザクション ID が無効です。

解説(Remarks)

トランザクションは同時に 1 つのプロセスしか所有できないため、MsiEmbeddedChainer テーブルに記述された関数は、MsiJoinTransaction を使用して、Windows インストーラー API でアプリケーションを構成またはインストールする前にトランザクションの所有権を要求できます。インストーラーは、進行中のインストールがないことを確認します。インストーラーは、所有権を要求するプロセスと現在トランザクションを所有しているプロセスが、同じプロセス ツリー内で親プロセスを共有していることを確認します。関数が成功すると、MsiJoinTransaction を呼び出したプロセスがトランザクションの現在の所有者になります。

MsiJoinTransaction は、新しいインストールの内部 UI を元のインストールの UI レベルに設定します。新しいインストールがトランザクションを所有した後は、MsiSetInternalUI を呼び出して UI レベルを変更できます。これにより、新しいインストールを元のインストールよりも高い UI レベルで実行できます。

出典・ライセンス: 上記「公式ドキュメント」の内容は Microsoft の Win32 API ドキュメント(MicrosoftDocs/sdk-api)を日本語に翻訳・改変したものです。© Microsoft Corporation. CC BY 4.0 で提供。
Microsoft 公式リファレンス: 英語 (en-us) · 日本語 (ja-jp) · 原文ソース (GitHub)

各言語での呼び出し定義

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

DWORD MsiJoinTransaction(
    MSIHANDLE hTransactionHandle,
    DWORD dwTransactionAttributes,
    HANDLE* phChangeOfOwnerEvent
);
[DllImport("msi.dll", ExactSpelling = true)]
static extern uint MsiJoinTransaction(
    uint hTransactionHandle,   // MSIHANDLE
    uint dwTransactionAttributes,   // DWORD
    IntPtr phChangeOfOwnerEvent   // HANDLE* out
);
<DllImport("msi.dll", ExactSpelling:=True)>
Public Shared Function MsiJoinTransaction(
    hTransactionHandle As UInteger,   ' MSIHANDLE
    dwTransactionAttributes As UInteger,   ' DWORD
    phChangeOfOwnerEvent As IntPtr   ' HANDLE* out
) As UInteger
End Function
' hTransactionHandle : MSIHANDLE
' dwTransactionAttributes : DWORD
' phChangeOfOwnerEvent : HANDLE* out
Declare PtrSafe Function MsiJoinTransaction Lib "msi" ( _
    ByVal hTransactionHandle As Long, _
    ByVal dwTransactionAttributes 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

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

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

var (
	msi = windows.NewLazySystemDLL("msi.dll")
	procMsiJoinTransaction = msi.NewProc("MsiJoinTransaction")
)

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

extern "msi" fn MsiJoinTransaction(
    hTransactionHandle: u32, // MSIHANDLE
    dwTransactionAttributes: u32, // DWORD
    phChangeOfOwnerEvent: ?*anyopaque // HANDLE* out
) callconv(std.os.windows.WINAPI) u32;
proc MsiJoinTransaction(
    hTransactionHandle: uint32,  # MSIHANDLE
    dwTransactionAttributes: uint32,  # DWORD
    phChangeOfOwnerEvent: pointer  # HANDLE* out
): uint32 {.importc: "MsiJoinTransaction", stdcall, dynlib: "msi.dll".}
pragma(lib, "msi");
extern(Windows)
uint MsiJoinTransaction(
    uint hTransactionHandle,   // MSIHANDLE
    uint dwTransactionAttributes,   // DWORD
    void* phChangeOfOwnerEvent   // HANDLE* out
);
ccall((:MsiJoinTransaction, "msi.dll"), stdcall, UInt32,
      (UInt32, UInt32, Ptr{Cvoid}),
      hTransactionHandle, dwTransactionAttributes, phChangeOfOwnerEvent)
# hTransactionHandle : MSIHANDLE -> UInt32
# dwTransactionAttributes : DWORD -> UInt32
# phChangeOfOwnerEvent : HANDLE* out -> Ptr{Cvoid}
# stdcall は 32bit のみ意味を持つ(x64 では無視)。
local ffi = require("ffi")
ffi.cdef[[
uint32_t MsiJoinTransaction(
    uint32_t hTransactionHandle,
    uint32_t dwTransactionAttributes,
    void* phChangeOfOwnerEvent);
]]
local msi = ffi.load("msi")
-- msi.MsiJoinTransaction(hTransactionHandle, dwTransactionAttributes, phChangeOfOwnerEvent)
-- hTransactionHandle : MSIHANDLE
-- dwTransactionAttributes : DWORD
-- phChangeOfOwnerEvent : HANDLE* out
-- 構造体/GUIDへのポインタは cdef が通るよう void* で表記(実型は各引数コメント参照)。値渡し構造体・enum は対応する typedef を cdef に追加すること。
const koffi = require('koffi');
const lib = koffi.load('msi.dll');
const MsiJoinTransaction = lib.func('__stdcall', 'MsiJoinTransaction', 'uint32_t', ['uint32_t', 'uint32_t', 'void *']);
// MsiJoinTransaction(hTransactionHandle, dwTransactionAttributes, phChangeOfOwnerEvent)
// hTransactionHandle : MSIHANDLE -> 'uint32_t'
// dwTransactionAttributes : DWORD -> 'uint32_t'
// phChangeOfOwnerEvent : HANDLE* out -> 'void *'
// 出力ポインタは koffi.out(...) で包む。構造体は koffi.struct で定義。
const lib = Deno.dlopen("msi.dll", {
  MsiJoinTransaction: { parameters: ["u32", "u32", "pointer"], result: "u32" },
});
// lib.symbols.MsiJoinTransaction(hTransactionHandle, dwTransactionAttributes, phChangeOfOwnerEvent)
// hTransactionHandle : MSIHANDLE -> "u32"
// dwTransactionAttributes : DWORD -> "u32"
// phChangeOfOwnerEvent : HANDLE* out -> "pointer"
// 文字列引数は "buffer"(NUL 終端のバイト列を Uint8Array で渡す)。
// 値渡し構造体は { struct: [ ...field types... ] } を使用。
<?php
$ffi = FFI::cdef(<<<C
uint32_t MsiJoinTransaction(
    uint32_t hTransactionHandle,
    uint32_t dwTransactionAttributes,
    void* phChangeOfOwnerEvent);
C, "msi.dll");
// $ffi->MsiJoinTransaction(hTransactionHandle, dwTransactionAttributes, phChangeOfOwnerEvent);
// hTransactionHandle : MSIHANDLE
// dwTransactionAttributes : DWORD
// 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);
    int MsiJoinTransaction(
        int hTransactionHandle,   // MSIHANDLE
        int dwTransactionAttributes,   // DWORD
        Pointer phChangeOfOwnerEvent   // HANDLE* out
    );
}
@[Link("msi")]
lib Libmsi
  fun MsiJoinTransaction = MsiJoinTransaction(
    hTransactionHandle : UInt32,   # MSIHANDLE
    dwTransactionAttributes : UInt32,   # DWORD
    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 MsiJoinTransactionNative = Uint32 Function(Uint32, Uint32, Pointer<Void>);
typedef MsiJoinTransactionDart = int Function(int, int, Pointer<Void>);
final MsiJoinTransaction = DynamicLibrary.open('msi.dll')
    .lookupFunction<MsiJoinTransactionNative, MsiJoinTransactionDart>('MsiJoinTransaction');
// hTransactionHandle : MSIHANDLE -> Uint32
// dwTransactionAttributes : DWORD -> Uint32
// phChangeOfOwnerEvent : HANDLE* out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function MsiJoinTransaction(
  hTransactionHandle: DWORD;   // MSIHANDLE
  dwTransactionAttributes: DWORD;   // DWORD
  phChangeOfOwnerEvent: Pointer   // HANDLE* out
): DWORD; stdcall;
  external 'msi.dll' name 'MsiJoinTransaction';
import Foreign
import Foreign.C.Types
import Foreign.C.String

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

let msijointransaction =
  foreign "MsiJoinTransaction"
    (uint32_t @-> uint32_t @-> (ptr void) @-> returning uint32_t)
(* hTransactionHandle : MSIHANDLE -> uint32_t *)
(* dwTransactionAttributes : DWORD -> 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 ("MsiJoinTransaction" msi-join-transaction :convention :stdcall) :uint32
  (h-transaction-handle :uint32)   ; MSIHANDLE
  (dw-transaction-attributes :uint32)   ; DWORD
  (ph-change-of-owner-event :pointer))   ; HANDLE* out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $MsiJoinTransaction = Win32::API::More->new('msi',
    'DWORD MsiJoinTransaction(DWORD hTransactionHandle, DWORD dwTransactionAttributes, HANDLE phChangeOfOwnerEvent)');
# my $ret = $MsiJoinTransaction->Call($hTransactionHandle, $dwTransactionAttributes, $phChangeOfOwnerEvent);
# hTransactionHandle : MSIHANDLE -> DWORD
# dwTransactionAttributes : DWORD -> DWORD
# phChangeOfOwnerEvent : HANDLE* out -> HANDLE
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。