Edit

Share via

FSCTL_TXFS_LIST_TRANSACTION_LOCKED_FILES IOCTL (winioctl.h)

  • Article

Note

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.

Returns a list of all files currently locked by the specified transaction. If the return value is ERROR_MORE_DATA, it returns the length of the buffer required to hold the complete list of files at the time of this call.

BOOL DeviceIoControl(
  (HANDLE) hDevice,                         // handle to device
  FSCTL_TXFS_LIST_TRANSACTION_LOCKED_FILES, // dwIoControlCode
  (LPVOID) lpInBuffer,                      // input buffer
  (DWORD) nInBufferSize,                    // size of input buffer
  (LPVOID) lpOutBuffer,                     // output buffer
  (DWORD) nOutBufferSize,                   // size of output buffer
  (LPDWORD) lpBytesReturned,                // number of bytes returned
  (LPOVERLAPPED) lpOverlapped );            // OVERLAPPED structure
);

Remarks

FSCTL_TXFS_LIST_TRANSACTION_LOCKED_FILES is a synchronous operation.

The file path names returned are relative to the volume root.

The number of files returned from one call to the next can change depending on the number of active transactions at any given point in time. If this call returns a request for a larger buffer, that size may or may not be adequate for the next call, based on the number of active transactions at the time of the next call.

ReFS:  This code is not supported.

Requirements

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

See also