ホーム › Storage.FileSystem › GetNotificationResourceManagerAsync

GetNotificationResourceManagerAsync

関数

KTMリソースマネージャーから通知を非同期で取得する。

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

シグネチャ

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

BOOL GetNotificationResourceManagerAsync(
    HANDLE ResourceManagerHandle,
    TRANSACTION_NOTIFICATION* TransactionNotification,
    DWORD TransactionNotificationLength,
    DWORD* ReturnLength,
    OVERLAPPED* lpOverlapped
);

パラメーター

名前	型	方向	説明
ResourceManagerHandle	HANDLE	in	リソースマネージャーへのハンドル。
TransactionNotification	TRANSACTION_NOTIFICATION*	inout	最初に利用可能な通知を受け取る TRANSACTION_NOTIFICATION 構造体へのポインター。
TransactionNotificationLength	DWORD	in	TransactionNotification バッファーのサイズ (バイト単位)。
ReturnLength	DWORD*	inout	TransactionNotification パラメーターによって受信された通知の実際のサイズを受け取る変数へのポインター。
lpOverlapped	OVERLAPPED*	inout	非同期操作に必要な OVERLAPPED 構造体へのポインター。

戻り値の型: 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 を参照してください。

リソースマネージャー (RM) は、KTM が通知を配信する際に使用する複数のバッファーを提供するために、この関数を複数回呼び出すことができます。この関数の呼び出し回数は、RM が処理している負荷の大きさに依存します。

この関数は、 SetResourceManagerCompletionPort 関数を呼び出した後に呼び出す必要があります。

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

各言語での呼び出し定義

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

BOOL GetNotificationResourceManagerAsync(
    HANDLE ResourceManagerHandle,
    TRANSACTION_NOTIFICATION* TransactionNotification,
    DWORD TransactionNotificationLength,
    DWORD* ReturnLength,
    OVERLAPPED* lpOverlapped
);

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

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

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

import ctypes
from ctypes import wintypes

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

require 'fiddle'
require 'fiddle/import'

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

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

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

出力引数:

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