Win32 API 日本語リファレンス
ホームStorage.FileSystem › GetTransactionId

GetTransactionId

関数
KTMトランザクションのGUID識別子を取得する。
DLLktmw32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

BOOL GetTransactionId(
    HANDLE TransactionHandle,
    GUID* TransactionId
);

パラメーター

名前方向説明
TransactionHandleHANDLEinトランザクションへのハンドル。
TransactionIdGUID*inoutトランザクションの ID を受け取る変数へのポインター。

戻り値の型: BOOL

公式ドキュメント

指定されたトランザクションの識別子 (ID) を取得します。

戻り値

関数が成功した場合、戻り値は 0 以外の値になります。

関数が失敗した場合、戻り値は 0 (ゼロ) になります。拡張エラー情報を取得するには、GetLastError 関数を呼び出します。

次の一覧は、発生し得るエラーコードを示しています:

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

各言語での呼び出し定義

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

BOOL GetTransactionId(
    HANDLE TransactionHandle,
    GUID* TransactionId
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ktmw32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetTransactionId(
    IntPtr TransactionHandle,   // HANDLE
    ref Guid TransactionId   // GUID* in/out
);
<DllImport("ktmw32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetTransactionId(
    TransactionHandle As IntPtr,   ' HANDLE
    ByRef TransactionId As Guid   ' GUID* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' TransactionHandle : HANDLE
' TransactionId : GUID* in/out
Declare PtrSafe Function GetTransactionId Lib "ktmw32" ( _
    ByVal TransactionHandle As LongPtr, _
    ByVal TransactionId As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

GetTransactionId = ctypes.windll.ktmw32.GetTransactionId
GetTransactionId.restype = wintypes.BOOL
GetTransactionId.argtypes = [
    wintypes.HANDLE,  # TransactionHandle : HANDLE
    ctypes.c_void_p,  # TransactionId : GUID* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ktmw32.dll')
GetTransactionId = Fiddle::Function.new(
  lib['GetTransactionId'],
  [
    Fiddle::TYPE_VOIDP,  # TransactionHandle : HANDLE
    Fiddle::TYPE_VOIDP,  # TransactionId : GUID* in/out
  ],
  Fiddle::TYPE_INT)
#[link(name = "ktmw32")]
extern "system" {
    fn GetTransactionId(
        TransactionHandle: *mut core::ffi::c_void,  // HANDLE
        TransactionId: *mut GUID  // GUID* in/out
    ) -> i32;
}
// crates: windows-sys provides ready-made bindings for this API.
$sig = @"
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ktmw32.dll", SetLastError = true)]
public static extern bool GetTransactionId(IntPtr TransactionHandle, ref Guid TransactionId);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ktmw32_GetTransactionId' -Namespace Win32 -PassThru
# $api::GetTransactionId(TransactionHandle, TransactionId)
#uselib "ktmw32.dll"
#func global GetTransactionId "GetTransactionId" sptr, sptr
; GetTransactionId TransactionHandle, varptr(TransactionId)   ; 戻り値は stat
; TransactionHandle : HANDLE -> "sptr"
; TransactionId : GUID* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
出力引数:
#uselib "ktmw32.dll"
#cfunc global GetTransactionId "GetTransactionId" sptr, var
; res = GetTransactionId(TransactionHandle, TransactionId)
; TransactionHandle : HANDLE -> "sptr"
; TransactionId : GUID* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
出力引数:
; BOOL GetTransactionId(HANDLE TransactionHandle, GUID* TransactionId)
#uselib "ktmw32.dll"
#cfunc global GetTransactionId "GetTransactionId" intptr, var
; res = GetTransactionId(TransactionHandle, TransactionId)
; TransactionHandle : HANDLE -> "intptr"
; TransactionId : GUID* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	ktmw32 = windows.NewLazySystemDLL("ktmw32.dll")
	procGetTransactionId = ktmw32.NewProc("GetTransactionId")
)

// TransactionHandle (HANDLE), TransactionId (GUID* in/out)
r1, _, err := procGetTransactionId.Call(
	uintptr(TransactionHandle),
	uintptr(TransactionId),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function GetTransactionId(
  TransactionHandle: THandle;   // HANDLE
  TransactionId: PGUID   // GUID* in/out
): BOOL; stdcall;
  external 'ktmw32.dll' name 'GetTransactionId';
result := DllCall("ktmw32\GetTransactionId"
    , "Ptr", TransactionHandle   ; HANDLE
    , "Ptr", TransactionId   ; GUID* in/out
    , "Int")   ; return: BOOL
●GetTransactionId(TransactionHandle, TransactionId) = DLL("ktmw32.dll", "bool GetTransactionId(void*, void*)")
# 呼び出し: GetTransactionId(TransactionHandle, TransactionId)
# TransactionHandle : HANDLE -> "void*"
# TransactionId : GUID* in/out -> "void*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef GetTransactionIdNative = Int32 Function(Pointer<Void>, Pointer<Void>);
typedef GetTransactionIdDart = int Function(Pointer<Void>, Pointer<Void>);
final GetTransactionId = DynamicLibrary.open('ktmw32.dll')
    .lookupFunction<GetTransactionIdNative, GetTransactionIdDart>('GetTransactionId');
// TransactionHandle : HANDLE -> Pointer<Void>
// TransactionId : GUID* in/out -> Pointer<Void>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function GetTransactionId(
  TransactionHandle: THandle;   // HANDLE
  TransactionId: PGUID   // GUID* in/out
): BOOL; stdcall;
  external 'ktmw32.dll' name 'GetTransactionId';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "GetTransactionId"
  c_GetTransactionId :: Ptr () -> Ptr () -> IO CInt
-- TransactionHandle : HANDLE -> Ptr ()
-- TransactionId : GUID* in/out -> Ptr ()
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let gettransactionid =
  foreign "GetTransactionId"
    ((ptr void) @-> (ptr void) @-> returning int32_t)
(* TransactionHandle : HANDLE -> (ptr void) *)
(* TransactionId : GUID* in/out -> (ptr void) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library ktmw32 (t "ktmw32.dll"))
(cffi:use-foreign-library ktmw32)

(cffi:defcfun ("GetTransactionId" get-transaction-id :convention :stdcall) :int32
  (transaction-handle :pointer)   ; HANDLE
  (transaction-id :pointer))   ; GUID* in/out
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $GetTransactionId = Win32::API::More->new('ktmw32',
    'BOOL GetTransactionId(HANDLE TransactionHandle, LPVOID TransactionId)');
# my $ret = $GetTransactionId->Call($TransactionHandle, $TransactionId);
# TransactionHandle : HANDLE -> HANDLE
# TransactionId : GUID* in/out -> LPVOID
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。