ZwRollforwardTransactionManager routine

The ZwRollforwardTransactionManager routine initiates recovery operations for all of the in-progress transactions that are assigned to a specified transaction manager.

Syntax


NTSTATUS ZwRollforwardTransactionManager(
  _In_      HANDLE TransactionManagerHandle,
  _In_opt_  PLARGE_INTEGER TmVirtualClock
);

Parameters

TransactionManagerHandle [in]

A handle to a transaction manager object that was obtained by a previous call to ZwCreateTransactionManager or ZwOpenTransactionManager. The handle must have TRANSACTIONMANAGER_RECOVER access to the object.

TmVirtualClock [in, optional]

A pointer to a virtual clock value. This parameter is optional and can be NULL. For more information about this parameter, see the following Remarks section.

Return value

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

Return codeDescription
STATUS_OBJECT_TYPE_MISMATCH

The specified handle is not a handle to a transaction manager object.

STATUS_INVALID_HANDLE

An object handle is invalid.

STATUS_ACCESS_DENIED

The caller does not have appropriate access to the transaction manager object.

STATUS_TM_VOLATILE

The specified transaction manager object does not have a log file, so recovery is not available.

STATUS_UNSUCCESSFUL

The specified transaction manager object is in an unexpected state.

 

The routine might return other NTSTATUS values.

Remarks

The ZwRollforwardTransactionManager routine recovers all logged activity that KTM finds in the transaction manager's log file, up to and including the virtual clock value that the TmVirtualClock parameter supplies.

Your component can traverse the log file incrementally by calling ZwRollforwardTransactionManager repetitively and setting the VirtualClock parameter to a higher value before each call.

If the TmVirtualClock parameter is NULL, calling ZwRollforwardTransactionManager is equivalent to calling ZwRecoverTransactionManager.

For more information about recovery operations, see Handling Recovery Operations.

Requirements

Version

Available in Windows Vista and later versions of Windows.

Header

Wdm.h (include Wdm.h, Ntddk.h, or Ntifs.h)

Library

Ntoskrnl.lib

IRQL

PASSIVE_LEVEL

DDI compliance rules

PowerIrpDDis, HwStorPortProhibitedDDIs

See also

TmRecoverTransactionManager
ZwCreateTransactionManager
ZwOpenTransactionManager
ZwRecoverTransactionManager

 

 

Send comments about this topic to Microsoft

Show:
© 2014 Microsoft