ホーム › Storage.FileSystem › GetNotificationResourceManager

GetNotificationResourceManager

関数

KTMリソースマネージャーからトランザクション通知を取得する。

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

シグネチャ

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

BOOL GetNotificationResourceManager(
    HANDLE ResourceManagerHandle,
    TRANSACTION_NOTIFICATION* TransactionNotification,
    DWORD NotificationLength,
    DWORD dwMilliseconds,
    DWORD* ReturnLength
);

パラメーター

名前	型	方向	説明
ResourceManagerHandle	HANDLE	in	リソースマネージャーへのハンドル。
TransactionNotification	TRANSACTION_NOTIFICATION*	inout	最初に利用可能な通知を受け取る TRANSACTION_NOTIFICATION 構造体へのポインター。
NotificationLength	DWORD	in	TransactionNotification バッファーのサイズ (バイト単位)。
dwMilliseconds	DWORD	in	呼び出し元のアプリケーションが通知が利用可能になるのを待機する間ブロックする時間 (ミリ秒単位)。タイムアウトが経過した時点で利用可能な通知がない場合は、 ERROR_TIMEOUT が返されます。
ReturnLength	DWORD*	inout	TransactionNotification パラメーターによって受け取られた通知の実際のサイズを受け取る変数へのポインター。

戻り値の型: BOOL

公式ドキュメント

リソースマネージャー (RM) に対する通知を要求して受け取ります。この関数は、トランザクションの状態が変化したときに通知を受け取るために、RM レジスターによって使用されます。

戻り値

関数が成功した場合、戻り値は 0 以外です。

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

次の一覧は、発生する可能性のあるエラーコードを示しています。

解説(Remarks)

すべてのリソースマネージャーは、後で ReadOnlyEnlistment を呼び出してエンリストメントを読み取り専用としてマークする場合であっても、TRANSACTION_NOTIFY_PREPREPARE、 TRANSACTION_NOTIFY_PREPARE、および TRANSACTION_NOTIFY_COMMIT の各通知を受け取るように登録する必要があります。リソースマネージャーは TRANSACTION_NOTIFY_SINGLE_PHASE_COMMIT をサポートできますが、複数フェーズの pre-prepare、prepare、commit の各通知もサポートする必要があります。リソースマネージャーが受け取ることができるすべての通知の一覧については、 TRANSACTION_NOTIFICATION を参照してください。

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

各言語での呼び出し定義

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

BOOL GetNotificationResourceManager(
    HANDLE ResourceManagerHandle,
    TRANSACTION_NOTIFICATION* TransactionNotification,
    DWORD NotificationLength,
    DWORD dwMilliseconds,
    DWORD* ReturnLength
);

[return: MarshalAs(UnmanagedType.Bool)]
[DllImport("ktmw32.dll", SetLastError = true, ExactSpelling = true)]
static extern bool GetNotificationResourceManager(
    IntPtr ResourceManagerHandle,   // HANDLE
    IntPtr TransactionNotification,   // TRANSACTION_NOTIFICATION* in/out
    uint NotificationLength,   // DWORD
    uint dwMilliseconds,   // DWORD
    ref uint ReturnLength   // DWORD* in/out
);

<DllImport("ktmw32.dll", SetLastError:=True, ExactSpelling:=True)>
Public Shared Function GetNotificationResourceManager(
    ResourceManagerHandle As IntPtr,   ' HANDLE
    TransactionNotification As IntPtr,   ' TRANSACTION_NOTIFICATION* in/out
    NotificationLength As UInteger,   ' DWORD
    dwMilliseconds As UInteger,   ' DWORD
    ByRef ReturnLength As UInteger   ' DWORD* in/out
) As <MarshalAs(UnmanagedType.Bool)> Boolean
End Function

' ResourceManagerHandle : HANDLE
' TransactionNotification : TRANSACTION_NOTIFICATION* in/out
' NotificationLength : DWORD
' dwMilliseconds : DWORD
' ReturnLength : DWORD* in/out
Declare PtrSafe Function GetNotificationResourceManager Lib "ktmw32" ( _
    ByVal ResourceManagerHandle As LongPtr, _
    ByVal TransactionNotification As LongPtr, _
    ByVal NotificationLength As Long, _
    ByVal dwMilliseconds As Long, _
    ByRef ReturnLength As Long) As Long
' VBA7前提(PtrSafe)。32bit Office では LongPtr→Long。Integer=16bit / Long=32bit / LongLong=64bit。

import ctypes
from ctypes import wintypes

GetNotificationResourceManager = ctypes.windll.ktmw32.GetNotificationResourceManager
GetNotificationResourceManager.restype = wintypes.BOOL
GetNotificationResourceManager.argtypes = [
    wintypes.HANDLE,  # ResourceManagerHandle : HANDLE
    ctypes.c_void_p,  # TransactionNotification : TRANSACTION_NOTIFICATION* in/out
    wintypes.DWORD,  # NotificationLength : DWORD
    wintypes.DWORD,  # dwMilliseconds : DWORD
    ctypes.POINTER(wintypes.DWORD),  # ReturnLength : DWORD* in/out
]
# GetLastError: use ctypes.GetLastError() (or ctypes.WinDLL(use_last_error=True))

require 'fiddle'
require 'fiddle/import'

lib = Fiddle.dlopen('ktmw32.dll')
GetNotificationResourceManager = Fiddle::Function.new(
  lib['GetNotificationResourceManager'],
  [
    Fiddle::TYPE_VOIDP,  # ResourceManagerHandle : HANDLE
    Fiddle::TYPE_VOIDP,  # TransactionNotification : TRANSACTION_NOTIFICATION* in/out
    -Fiddle::TYPE_INT,  # NotificationLength : DWORD
    -Fiddle::TYPE_INT,  # dwMilliseconds : DWORD
    Fiddle::TYPE_VOIDP,  # ReturnLength : DWORD* in/out
  ],
  Fiddle::TYPE_INT)

#[link(name = "ktmw32")]
extern "system" {
    fn GetNotificationResourceManager(
        ResourceManagerHandle: *mut core::ffi::c_void,  // HANDLE
        TransactionNotification: *mut TRANSACTION_NOTIFICATION,  // TRANSACTION_NOTIFICATION* in/out
        NotificationLength: u32,  // DWORD
        dwMilliseconds: u32,  // DWORD
        ReturnLength: *mut u32  // DWORD* 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 GetNotificationResourceManager(IntPtr ResourceManagerHandle, IntPtr TransactionNotification, uint NotificationLength, uint dwMilliseconds, ref uint ReturnLength);
"@
$api = Add-Type -MemberDefinition $sig -Name 'ktmw32_GetNotificationResourceManager' -Namespace Win32 -PassThru
# $api::GetNotificationResourceManager(ResourceManagerHandle, TransactionNotification, NotificationLength, dwMilliseconds, ReturnLength)

#uselib "ktmw32.dll"
#func global GetNotificationResourceManager "GetNotificationResourceManager" sptr, sptr, sptr, sptr, sptr
; GetNotificationResourceManager ResourceManagerHandle, varptr(TransactionNotification), NotificationLength, dwMilliseconds, varptr(ReturnLength)   ; 戻り値は stat
; ResourceManagerHandle : HANDLE -> "sptr"
; TransactionNotification : TRANSACTION_NOTIFICATION* in/out -> "sptr"
; NotificationLength : DWORD -> "sptr"
; dwMilliseconds : DWORD -> "sptr"
; ReturnLength : DWORD* in/out -> "sptr"
; ※HSP3.7は #func のため戻り値はシステム変数 stat に格納されます。

出力引数:

#uselib "ktmw32.dll"
#cfunc global GetNotificationResourceManager "GetNotificationResourceManager" sptr, var, int, int, var
; res = GetNotificationResourceManager(ResourceManagerHandle, TransactionNotification, NotificationLength, dwMilliseconds, ReturnLength)
; ResourceManagerHandle : HANDLE -> "sptr"
; TransactionNotification : TRANSACTION_NOTIFICATION* in/out -> "var"
; NotificationLength : DWORD -> "int"
; dwMilliseconds : DWORD -> "int"
; ReturnLength : DWORD* in/out -> "var"
; ※出力/バッファ引数は var 方式(変数を直接渡す)。varptr 方式にも切替可。#uselib "ktmw32.dll"
#cfunc global GetNotificationResourceManager "GetNotificationResourceManager" sptr, sptr, int, int, sptr
; res = GetNotificationResourceManager(ResourceManagerHandle, varptr(TransactionNotification), NotificationLength, dwMilliseconds, varptr(ReturnLength))
; ResourceManagerHandle : HANDLE -> "sptr"
; TransactionNotification : TRANSACTION_NOTIFICATION* in/out -> "sptr"
; NotificationLength : DWORD -> "int"
; dwMilliseconds : DWORD -> "int"
; ReturnLength : DWORD* in/out -> "sptr"
; ※出力/バッファ引数はポインタ方式(token=sptr / 呼び出しは varptr(変数))。