ZwPrepareComplete function (wdm.h)

  • Article

The ZwPrepareComplete routine notifies KTM that the calling resource manager has finished preparing a transaction's data.

Syntax

NTSYSCALLAPI NTSTATUS ZwPrepareComplete(
  [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 handle must have ENLISTMENT_SUBORDINATE_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

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

Return code Description
STATUS_OBJECT_TYPE_MISMATCH
 The specified handle is not a handle to an enlistment object.
STATUS_INVALID_HANDLE
 The object handle is invalid.
STATUS_TRANSACTION_NOT_REQUESTED
 The transaction or its enlistment is not in the correct state.
STATUS_ACCESS_DENIED
 The caller does not have appropriate access to the enlistment object.
 

The routine might return other NTSTATUS values.

Remarks

A resource manager must call ZwPrepareComplete after it has finished servicing a TRANSACTION_NOTIFY_PREPARE notification.

After a resource manager has called ZwPrepareComplete, it cannot roll back the transaction.

For more information about ZwPrepareComplete, see Handling Commit Operations.

NtPrepareComplete and ZwPrepareComplete 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(storport), PowerIrpDDis(wdm)

See also

TmPrepareComplete

Using Nt and Zw Versions of the Native System Services Routines

ZwCreateEnlistment

ZwOpenEnlistment

ZwPrePrepareComplete