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

SetTransactionInformation

関数
KTMトランザクションの分離レベルやタイムアウトを設定する。
DLLktmw32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

BOOL SetTransactionInformation(
    HANDLE TransactionHandle,
    DWORD IsolationLevel,
    DWORD IsolationFlags,
    DWORD Timeout,
    LPWSTR Description   // optional
);

パラメーター

名前方向説明
TransactionHandleHANDLEinトランザクションへのハンドル。トランザクション情報を設定するには、ハンドルに TRANSACTION_SET_INFORMATION 権限が必要です。
IsolationLevelDWORDin予約済み。0 を指定してください。
IsolationFlagsDWORDin予約済み。
TimeoutDWORDinこのトランザクションのタイムアウト値(ミリ秒単位)。
DescriptionLPWSTRinoptionalこのトランザクションのユーザー定義の説明。

戻り値の型: BOOL

公式ドキュメント

指定されたトランザクションのトランザクション情報を設定します。

戻り値

関数が成功した場合、戻り値は 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 SetTransactionInformation(
    HANDLE TransactionHandle,
    DWORD IsolationLevel,
    DWORD IsolationFlags,
    DWORD Timeout,
    LPWSTR Description   // optional
);
[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ktmw32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool SetTransactionInformation(
    IntPtr TransactionHandle,   // HANDLE
    uint IsolationLevel,   // DWORD
    uint IsolationFlags,   // DWORD
    uint Timeout,   // DWORD
    [MarshalAs(UnmanagedType.LPWStr)] string Description   // LPWSTR optional
);
<DllImport("ktmw32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function SetTransactionInformation(
    TransactionHandle As IntPtr,   ' HANDLE
    IsolationLevel As UInteger,   ' DWORD
    IsolationFlags As UInteger,   ' DWORD
    Timeout As UInteger,   ' DWORD
    <MarshalAs(UnmanagedType.LPWStr)> Description As String   ' LPWSTR optional
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function
' TransactionHandle : HANDLE
' IsolationLevel : DWORD
' IsolationFlags : DWORD
' Timeout : DWORD
' Description : LPWSTR optional
Declare PtrSafe Function SetTransactionInformation Lib "ktmw32" ( _
    ByVal TransactionHandle As LongPtr, _
    ByVal IsolationLevel As Long, _
    ByVal IsolationFlags As Long, _
    ByVal Timeout As Long, _
    ByVal Description As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。
import ctypes
from ctypes import wintypes

SetTransactionInformation = ctypes.windll.ktmw32.SetTransactionInformation
SetTransactionInformation.restype = wintypes.BOOL
SetTransactionInformation.argtypes = [
    wintypes.HANDLE,  # TransactionHandle : HANDLE
    wintypes.DWORD,  # IsolationLevel : DWORD
    wintypes.DWORD,  # IsolationFlags : DWORD
    wintypes.DWORD,  # Timeout : DWORD
    wintypes.LPCWSTR,  # Description : LPWSTR optional
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))
require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ktmw32.dll')
SetTransactionInformation = Fiddle::Function.new(
  lib['SetTransactionInformation'],
  [
    Fiddle::TYPE_VOIDP,  # TransactionHandle : HANDLE
    -Fiddle::TYPE_INT,  # IsolationLevel : DWORD
    -Fiddle::TYPE_INT,  # IsolationFlags : DWORD
    -Fiddle::TYPE_INT,  # Timeout : DWORD
    Fiddle::TYPE_VOIDP,  # Description : LPWSTR optional
  ],
  Fiddle::TYPE_INT)
#[link(name = "ktmw32")]
extern "system" {
    fn SetTransactionInformation(
        TransactionHandle: *mut core::ffi::c_void,  // HANDLE
        IsolationLevel: u32,  // DWORD
        IsolationFlags: u32,  // DWORD
        Timeout: u32,  // DWORD
        Description: *mut u16  // LPWSTR optional
    ) -> 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 SetTransactionInformation(IntPtr TransactionHandle, uint IsolationLevel, uint IsolationFlags, uint Timeout, [MarshalAs(UnmanagedType.LPWStr)] string Description);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ktmw32_SetTransactionInformation' -Namespace Win32 -PassThru
# $api::SetTransactionInformation(TransactionHandle, IsolationLevel, IsolationFlags, Timeout, Description)
#uselib "ktmw32.dll"
#func global SetTransactionInformation "SetTransactionInformation" sptr, sptr, sptr, sptr, sptr
; SetTransactionInformation TransactionHandle, IsolationLevel, IsolationFlags, Timeout, Description   ; 戻り値は stat
; TransactionHandle : HANDLE -> "sptr"
; IsolationLevel : DWORD -> "sptr"
; IsolationFlags : DWORD -> "sptr"
; Timeout : DWORD -> "sptr"
; Description : LPWSTR optional -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。
#uselib "ktmw32.dll"
#cfunc global SetTransactionInformation "SetTransactionInformation" sptr, int, int, int, wstr
; res = SetTransactionInformation(TransactionHandle, IsolationLevel, IsolationFlags, Timeout, Description)
; TransactionHandle : HANDLE -> "sptr"
; IsolationLevel : DWORD -> "int"
; IsolationFlags : DWORD -> "int"
; Timeout : DWORD -> "int"
; Description : LPWSTR optional -> "wstr"
; BOOL SetTransactionInformation(HANDLE TransactionHandle, DWORD IsolationLevel, DWORD IsolationFlags, DWORD Timeout, LPWSTR Description)
#uselib "ktmw32.dll"
#cfunc global SetTransactionInformation "SetTransactionInformation" intptr, int, int, int, wstr
; res = SetTransactionInformation(TransactionHandle, IsolationLevel, IsolationFlags, Timeout, Description)
; TransactionHandle : HANDLE -> "intptr"
; IsolationLevel : DWORD -> "int"
; IsolationFlags : DWORD -> "int"
; Timeout : DWORD -> "int"
; Description : LPWSTR optional -> "wstr"
import (
	"golang.org/x/sys/windows"
	"unsafe"
)

var (
	ktmw32 = windows.NewLazySystemDLL("ktmw32.dll")
	procSetTransactionInformation = ktmw32.NewProc("SetTransactionInformation")
)

// TransactionHandle (HANDLE), IsolationLevel (DWORD), IsolationFlags (DWORD), Timeout (DWORD), Description (LPWSTR optional)
r1, _, err := procSetTransactionInformation.Call(
	uintptr(TransactionHandle),
	uintptr(IsolationLevel),
	uintptr(IsolationFlags),
	uintptr(Timeout),
	uintptr(unsafe.Pointer(windows.StringToUTF16Ptr(Description))),
)
_ = err  // syscall.Errno (valid when the call sets last-error)
_ = r1   // BOOL
function SetTransactionInformation(
  TransactionHandle: THandle;   // HANDLE
  IsolationLevel: DWORD;   // DWORD
  IsolationFlags: DWORD;   // DWORD
  Timeout: DWORD;   // DWORD
  Description: PWideChar   // LPWSTR optional
): BOOL; stdcall;
  external 'ktmw32.dll' name 'SetTransactionInformation';
result := DllCall("ktmw32\SetTransactionInformation"
    , "Ptr", TransactionHandle   ; HANDLE
    , "UInt", IsolationLevel   ; DWORD
    , "UInt", IsolationFlags   ; DWORD
    , "UInt", Timeout   ; DWORD
    , "WStr", Description   ; LPWSTR optional
    , "Int")   ; return: BOOL
●SetTransactionInformation(TransactionHandle, IsolationLevel, IsolationFlags, Timeout, Description) = DLL("ktmw32.dll", "bool SetTransactionInformation(void*, dword, dword, dword, char*)")
# 呼び出し: SetTransactionInformation(TransactionHandle, IsolationLevel, IsolationFlags, Timeout, Description)
# TransactionHandle : HANDLE -> "void*"
# IsolationLevel : DWORD -> "dword"
# IsolationFlags : DWORD -> "dword"
# Timeout : DWORD -> "dword"
# Description : LPWSTR optional -> "char*"
# なでしこ1は32bit・ANSI(Shift_JIS)。文字列=char*(ANSI)、ポインタ/ハンドル=void*(4byte)。
const std = @import("std");

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

typedef SetTransactionInformationNative = Int32 Function(Pointer<Void>, Uint32, Uint32, Uint32, Pointer<Utf16>);
typedef SetTransactionInformationDart = int Function(Pointer<Void>, int, int, int, Pointer<Utf16>);
final SetTransactionInformation = DynamicLibrary.open('ktmw32.dll')
    .lookupFunction<SetTransactionInformationNative, SetTransactionInformationDart>('SetTransactionInformation');
// TransactionHandle : HANDLE -> Pointer<Void>
// IsolationLevel : DWORD -> Uint32
// IsolationFlags : DWORD -> Uint32
// Timeout : DWORD -> Uint32
// Description : LPWSTR optional -> Pointer<Utf16>
// 文字列は package:ffi の "...".toNativeUtf16()/toNativeUtf8() で変換。
{$mode objfpc}{$H+}
function SetTransactionInformation(
  TransactionHandle: THandle;   // HANDLE
  IsolationLevel: DWORD;   // DWORD
  IsolationFlags: DWORD;   // DWORD
  Timeout: DWORD;   // DWORD
  Description: PWideChar   // LPWSTR optional
): BOOL; stdcall;
  external 'ktmw32.dll' name 'SetTransactionInformation';
import Foreign
import Foreign.C.Types
import Foreign.C.String

foreign import stdcall safe "SetTransactionInformation"
  c_SetTransactionInformation :: Ptr () -> Word32 -> Word32 -> Word32 -> CWString -> IO CInt
-- TransactionHandle : HANDLE -> Ptr ()
-- IsolationLevel : DWORD -> Word32
-- IsolationFlags : DWORD -> Word32
-- Timeout : DWORD -> Word32
-- Description : LPWSTR optional -> CWString
-- 要 GHC(Windows)。stdcall は x64 では ccall として扱われる。ブロックする API は safe 呼び出し推奨。
open Ctypes
open Foreign

let settransactioninformation =
  foreign "SetTransactionInformation"
    ((ptr void) @-> uint32_t @-> uint32_t @-> uint32_t @-> (ptr uint16_t) @-> returning int32_t)
(* TransactionHandle : HANDLE -> (ptr void) *)
(* IsolationLevel : DWORD -> uint32_t *)
(* IsolationFlags : DWORD -> uint32_t *)
(* Timeout : DWORD -> uint32_t *)
(* Description : LPWSTR optional -> (ptr uint16_t) *)
(* foreign は cdecl 前提。x64 Windows では WINAPI と一致。構造体は ctypes structure を定義のこと。 *)
(cffi:define-foreign-library ktmw32 (t "ktmw32.dll"))
(cffi:use-foreign-library ktmw32)

(cffi:defcfun ("SetTransactionInformation" set-transaction-information :convention :stdcall) :int32
  (transaction-handle :pointer)   ; HANDLE
  (isolation-level :uint32)   ; DWORD
  (isolation-flags :uint32)   ; DWORD
  (timeout :uint32)   ; DWORD
  (description (:string :encoding :utf-16le)))   ; LPWSTR optional
; isize/usize(INT_PTR/SIZE_T)は x64 前提で :int64/:uint64。x86 では :int32/:uint32。
use Win32::API;
my $SetTransactionInformation = Win32::API::More->new('ktmw32',
    'BOOL SetTransactionInformation(HANDLE TransactionHandle, DWORD IsolationLevel, DWORD IsolationFlags, DWORD Timeout, LPCWSTR Description)');
# my $ret = $SetTransactionInformation->Call($TransactionHandle, $IsolationLevel, $IsolationFlags, $Timeout, $Description);
# TransactionHandle : HANDLE -> HANDLE
# IsolationLevel : DWORD -> DWORD
# IsolationFlags : DWORD -> DWORD
# Timeout : DWORD -> DWORD
# Description : LPWSTR optional -> LPCWSTR
# 値渡し構造体は pack() した文字列、または Win32::API::Struct を使用。

関連項目

公式の関連項目