TmRequestOutcomeEnlistment function (wdm.h)

Article
02/25/2022

The TmRequestOutcomeEnlistment routine asks KTM to try to provide an immediate outcome (commit or rollback) for the transaction that is associated with a specified enlistment.

Syntax

NTSTATUS TmRequestOutcomeEnlistment(
  [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

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

Return code	Description
STATUS_TRANSACTION_REQUEST_NOT_VALID	The specified enlistment is a superior enlistment.

The routine might return other NTSTATUS values.

Remarks

The TmRequestOutcomeEnlistment routine asks KTM to try to provide an immediate outcome (result) for the transaction. A resource manager can call TmRequestOutcomeEnlistment after it has called TmPrepareComplete or ZwPrepareComplete, if it later discovers that it cannot wait for an outcome because, for example, a surprise-removal of the disk has occurred. KTM might be able to force a rollback if all resource managers have not finished their prepare operations.

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

For more information about TmCreateEnlistment, see Creating a Resource Manager.

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