NtPrePrepareEnlistment function (wdm.h)

Article
03/11/2022

The ZwPrePrepareEnlistment routine initiates the pre-prepare operation for a specified enlistment's transaction.

Syntax

__kernel_entry NTSYSCALLAPI NTSTATUS NtPrePrepareEnlistment(
  [in]           HANDLE         EnlistmentHandle,
  [in, optional] PLARGE_INTEGER TmVirtualClock
);

Parameters

[in] EnlistmentHandle

A handle to an enlistment object that was obtained by a previous call to ZwCreateEnlistment or ZwOpenEnlistment. The object must represent a superior enlistment and the handle must have ENLISTMENT_SUPERIOR_RIGHTS access to the object.

[in, optional] TmVirtualClock

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

Return value

ZwPrePrepareEnlistment returns STATUS_SUCCESS if the operation succeeds. Otherwise, this routine might return one of the following values:

Return code	Description
STATUS_ENLISTMENT_NOT_SUPERIOR	The caller is not a superior transaction manager for the enlistment.
STATUS_TRANSACTION_RESPONSE_NOT_ENLISTED	The caller did not register to receive TRANSACTION_NOTIFY_PREPREPARE_COMPLETE notifications.
STATUS_OBJECT_TYPE_MISMATCH	The specified handle is not a handle to an enlistment object.
STATUS_INVALID_HANDLE	The object handle is invalid.
STATUS_ACCESS_DENIED	The caller does not have appropriate access to the enlistment object.
STATUS_TRANSACTION_REQUEST_NOT_VALID	The enlistment's transaction is not in a state that allows it to enter the prepare phase.

The routine might return other NTSTATUS values.

Remarks

Only superior transaction managers can call ZwPrePrepareEnlistment.

Callers of ZwPrePrepareEnlistment must register to receive TRANSACTION_NOTIFY_PREPREPARE_COMPLETE notifications.

The ZwPrePrepareEnlistment routine causes KTM to send TRANSACTION_NOTIFY_PREPREPARE notifications to all resource managers that have enlisted in the transaction.

For more information about ZwPrePrepareEnlistment, see Creating a Superior Transaction Manager and Handling Commit Operations.

NtPrepareEnlistment and ZwPrepareEnlistment are two versions of the same Windows Native System Services routine.

For calls from kernel-mode drivers, the NtXxx and ZwXxx versions of a Windows Native System Services routine can behave differently in the way that they handle and interpret input parameters. For more information about the relationship between the NtXxx and ZwXxx versions of a routine, see Using Nt and Zw Versions of the Native System Services 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, Ntifs.h)
Library	NtosKrnl.lib
DLL	NtosKrnl.exe
IRQL	PASSIVE_LEVEL
DDI compliance rules	HwStorPortProhibitedDDIs, PowerIrpDDis