ホーム › Storage.FileSystem › RenameTransactionManager

RenameTransactionManager

関数

KTMトランザクションマネージャーのGUIDを変更する。

DLLktmw32.dll呼出規約winapiSetLastErrorあり対応OSWindows Vista 以降

シグネチャ

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

BOOL RenameTransactionManager(
    LPWSTR LogFileName,
    GUID* ExistingTransactionManagerGuid
);

パラメーター

名前	型	方向	説明
LogFileName	LPWSTR	in	ログストリームの名前。このストリームは CLFS ログファイル内に存在している必要があります。
ExistingTransactionManagerGuid	GUID*	inout	TM の現在の名前を指定する値。

戻り値の型: BOOL

公式ドキュメント

トランザクションマネージャー (TM) オブジェクトの名前を変更します。この関数は、名前付きの TM ハンドルに対してのみ使用できます。

戻り値

関数が成功した場合、戻り値は 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 RenameTransactionManager(
    LPWSTR LogFileName,
    GUID* ExistingTransactionManagerGuid
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ktmw32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool RenameTransactionManager(
    [MarshalAs(UnmanagedType.LPWStr)] string LogFileName,   // LPWSTR
    ref Guid ExistingTransactionManagerGuid   // GUID* in/out
);

<DllImport("ktmw32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function RenameTransactionManager(
    <MarshalAs(UnmanagedType.LPWStr)> LogFileName As String,   ' LPWSTR
    ByRef ExistingTransactionManagerGuid As Guid   ' GUID* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' LogFileName : LPWSTR
' ExistingTransactionManagerGuid : GUID* in/out
Declare PtrSafe Function RenameTransactionManager Lib "ktmw32" ( _
    ByVal LogFileName As LongPtr, _
    ByVal ExistingTransactionManagerGuid As LongPtr) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

RenameTransactionManager = ctypes.windll.ktmw32.RenameTransactionManager
RenameTransactionManager.restype = wintypes.BOOL
RenameTransactionManager.argtypes = [
    wintypes.LPCWSTR,  # LogFileName : LPWSTR
    ctypes.c_void_p,  # ExistingTransactionManagerGuid : GUID* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ktmw32.dll')
RenameTransactionManager = Fiddle::Function.new(
  lib['RenameTransactionManager'],
  [
    Fiddle::TYPE_VOIDP,  # LogFileName : LPWSTR
    Fiddle::TYPE_VOIDP,  # ExistingTransactionManagerGuid : GUID* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "ktmw32")]
extern "system" {
    fn RenameTransactionManager(
        LogFileName: *mut u16,  // LPWSTR
        ExistingTransactionManagerGuid: *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 RenameTransactionManager([MarshalAs(UnmanagedType.LPWStr)] string LogFileName, ref Guid ExistingTransactionManagerGuid);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ktmw32_RenameTransactionManager' -Namespace Win32 -PassThru
# $api::RenameTransactionManager(LogFileName, ExistingTransactionManagerGuid)

#uselib "ktmw32.dll"
#func global RenameTransactionManager "RenameTransactionManager" sptr, sptr
; RenameTransactionManager LogFileName, varptr(ExistingTransactionManagerGuid)   ; 戻り値は stat
; LogFileName : LPWSTR -> "sptr"
; ExistingTransactionManagerGuid : GUID* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ktmw32.dll"
#cfunc global RenameTransactionManager "RenameTransactionManager" wstr, var
; res = RenameTransactionManager(LogFileName, ExistingTransactionManagerGuid)
; LogFileName : LPWSTR -> "wstr"
; ExistingTransactionManagerGuid : GUID* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ktmw32.dll"
#cfunc global RenameTransactionManager "RenameTransactionManager" wstr, sptr
; res = RenameTransactionManager(LogFileName, varptr(ExistingTransactionManagerGuid))
; LogFileName : LPWSTR -> "wstr"
; ExistingTransactionManagerGuid : GUID* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。