TmRollbackEnlistment function (wdm.h)

The TmRollbackEnlistment routine rolls back a specified enlistment.

Syntax

NTSTATUS TmRollbackEnlistment(
  [in] PKENLISTMENT   Enlistment,
  [in] PLARGE_INTEGER TmVirtualClock
);

Parameters

[in] Enlistment

A pointer to an enlistment object. Your component can receive this pointer as input to a ResourceManagerNotification callback routine. Alternatively, your component can call ObReferenceObjectByHandle and supply the object handle that a previous call to ZwCreateEnlistment, TmCreateEnlistment, or ZwOpenEnlistment provided.

[in] TmVirtualClock

A pointer to a virtual clock value. This parameter is optional and can be NULL.

Return value

TmRollbackEnlistment returns STATUS_SUCCESS if the operation succeeds. Otherwise, this routine might return the following value:

Return code Description
STATUS_TRANSACTION_REQUEST_NOT_VALID
The enlistment cannot be rolled back.
 

The routine might return other NTSTATUS values.

Remarks

The TmRollbackEnlistment routine is a pointer-based version of the ZwRollbackEnlistment routine.

For information about when to use KTM's TmXxx routines instead of ZwXxx routines, see Using TmXxx Routines.

Requirements

Requirement Value
Minimum supported client Available in Windows Vista and later operating system versions.
Target Platform Universal
Header wdm.h (include Wdm.h, Ntddk.h, Ntifs.h)
Library NtosKrnl.lib
DLL NtosKrnl.exe
IRQL PASSIVE_LEVEL

See also

ObReferenceObjectByHandle

ResourceManagerNotification

TmCreateEnlistment

ZwCreateEnlistment

ZwOpenEnlistment

ZwRollbackEnlistment