Edit

Share via

TXFS_SAVEPOINT_INFORMATION structure (winioctl.h)

  • Article

[Microsoft strongly recommends developers utilize alternative means to achieve your application’s needs. Many scenarios that TxF was developed for can be achieved through simpler and more readily available techniques. Furthermore, TxF may not be available in future versions of Microsoft Windows. For more information, and alternatives to TxF, please see Alternatives to using Transactional NTFS.]

The FSCTL_TXFS_SAVEPOINT_INFORMATION structure specifies the action to perform, and on which transaction.

Syntax

typedef struct _TXFS_SAVEPOINT_INFORMATION {
  HANDLE KtmTransaction;
  DWORD  ActionCode;
  DWORD  SavepointId;
} TXFS_SAVEPOINT_INFORMATION, *PTXFS_SAVEPOINT_INFORMATION;

Members

KtmTransaction

Handle to the transaction on which to perform the savepoint operation.

ActionCode

Specifies the savepoint action to perform. Valid values are:

Value Meaning
TXFS_SAVEPOINT_SET
1 (0x1)
 Creates a new savepoint.
TXFS_SAVEPOINT_ROLLBACK
2 (0x2)
 Rolls back to the savepoint specified by the SavepointId member.
TXFS_SAVEPOINT_CLEAR
4 (0x4)
 Clears the most recently set savepoint for the specified transaction.
TXFS_SAVEPOINT_CLEAR_ALL
16 (0x10)
 Clears all savepoints for the transaction.

SavepointId

If ActionCode is TXFS_SAVEPOINT_SET, on output, returns the newly-created savepoint ID.

If ActionCode is TXFS_ROLLBACK_TO_SAVEPOINT, on input, specifies the savepoint ID to roll back to. Remains unchanged on output.

If ActionCode is TXFS_SAVEPOINT_CLEAR or TXFS_SAVEPOINT_CLEAR_ALL, this member is not used; therefore, on input, specify NULL.

Requirements

Requirement Value
Minimum supported client Windows Vista with SP1 [desktop apps only]
Minimum supported server Windows Server 2008 [desktop apps only]
Header winioctl.h (include Windows.h)

See also

FSCTL_TXFS_SAVEPOINT_INFORMATION