NtPrepareEnlistment - NtDoc

Native API online documentation, based on the System Informer (formerly Process Hacker) phnt headers 
#ifndef _NTTMAPI_H

NTSYSCALLAPI
NTSTATUS
NTAPI
NtPrepareEnlistment(
    _In_ HANDLE EnlistmentHandle,
    _In_opt_ PLARGE_INTEGER TmVirtualClock
    );

#endif

View code on GitHub
#ifndef _NTZWAPI_H

NTSYSCALLAPI
NTSTATUS
NTAPI
ZwPrepareEnlistment(
    _In_ HANDLE EnlistmentHandle,
    _In_opt_ PLARGE_INTEGER TmVirtualClock
    );

#endif

View code on GitHub
// wdm.h

__kernel_entry NTSYSCALLAPI NTSTATUS NtPrepareEnlistment(
  [in]           HANDLE         EnlistmentHandle,
  [in, optional] PLARGE_INTEGER TmVirtualClock
);
View the official Windows Driver Kit DDI reference
// wdm.h

NTSYSCALLAPI NTSTATUS ZwPrepareEnlistment(
  [in]           HANDLE         EnlistmentHandle,
  [in, optional] PLARGE_INTEGER TmVirtualClock
);
View the official Windows Driver Kit DDI reference

NtDoc

This function is documented in Windows Driver Kit here and here.

Edit description on GitHub

Windows Driver Kit DDI reference (nf-wdm-ntprepareenlistment)

NtPrepareEnlistment function

Description

The ZwPrepareEnlistment routine initiates the prepare operation for a specified enlistment's transaction.

Parameters

EnlistmentHandle [in]

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.

TmVirtualClock [in, optional]

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

Return value

ZwPrepareEnlistment 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_PREPARE_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 ZwPrepareEnlistment.

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

Callers of ZwPrepareEnlistment must register to receive TRANSACTION_NOTIFY_PREPARE_COMPLETE notifications.

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

NtPrePrepareEnlistment and ZwPrePrepareEnlistment are two versions of the same Windows Native System Services routine.

For calls from kernel-mode drivers, the Nt*Xxx* and Zw*Xxx* 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 Nt*Xxx* and Zw*Xxx* versions of a routine, see Using Nt and Zw Versions of the Native System Services Routines.

See also

TmPrepareEnlistment

Using Nt and Zw Versions of the Native System Services Routines

ZwCreateEnlistment

ZwOpenEnlistment

View the official Windows Driver Kit DDI reference

Edit description on GitHub

Windows Driver Kit DDI reference (nf-wdm-zwprepareenlistment)

ZwPrepareEnlistment function

Description

The ZwPrepareEnlistment routine initiates the prepare operation for a specified enlistment's transaction.

Parameters

EnlistmentHandle [in]

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.

TmVirtualClock [in, optional]

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

Return value

ZwPrepareEnlistment 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_PREPARE_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 ZwPrepareEnlistment.

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

Callers of ZwPrepareEnlistment must register to receive TRANSACTION_NOTIFY_PREPARE_COMPLETE notifications.

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

NtPrePrepareEnlistment and ZwPrePrepareEnlistment are two versions of the same Windows Native System Services routine.

For calls from kernel-mode drivers, the Nt*Xxx* and Zw*Xxx* 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 Nt*Xxx* and Zw*Xxx* versions of a routine, see Using Nt and Zw Versions of the Native System Services Routines.

See also

TmPrepareEnlistment

Using Nt and Zw Versions of the Native System Services Routines

ZwCreateEnlistment

ZwOpenEnlistment

View the official Windows Driver Kit DDI reference

Edit description on GitHub