FSCTL_TXFS_LIST_TRANSACTION_LOCKED_FILES control code

[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

Parameters

To perform this operation, call the DeviceIoControl function with the following parameters.

hDevice

A handle to the root of the resource manager to query.

dwIoControlCode

The control code for the operation. Use FSCTL_TXFS_LIST_TRANSACTION_LOCKED_FILES for this operation.

lpInBuffer

Pointer to the lpOutBuffer buffer. On input, the KtmTransaction member must contain the GUID of the transaction.

nInBufferSize

The size of the input buffer, in bytes. This must be at least sizeof(TXFS_LIST_TRANSACTION_LOCKED_FILES).

lpOutBuffer

A pointer to the output buffer, a TXFS_LIST_TRANSACTION_LOCKED_FILES structure.

nOutBufferSize

The size of the output buffer, in bytes.

lpBytesReturned

A pointer to a variable that receives the size of the data stored in the output buffer, in bytes.

If lpOverlapped is NULL, lpBytesReturned cannot be NULL. Even when an operation returns no output data and lpOutBuffer is NULL, DeviceIoControl makes use of lpBytesReturned. After such an operation, the value of lpBytesReturned is meaningless.

If lpOverlapped is not NULL, lpBytesReturned can be NULL. If this parameter is not NULL and the operation returns data, lpBytesReturned is meaningless until the overlapped operation has completed. To retrieve the number of bytes returned, call GetOverlappedResult. If hDevice is associated with an I/O completion port, you can retrieve the number of bytes returned by calling GetQueuedCompletionStatus.

lpOverlapped

A pointer to an OVERLAPPED structure.

If hDevice was opened without specifying FILE_FLAG_OVERLAPPED, lpOverlapped is ignored.

If hDevice was opened with the FILE_FLAG_OVERLAPPED flag, the operation is performed as an overlapped (asynchronous) operation. In this case, lpOverlapped must point to a valid OVERLAPPED structure that contains a handle to an event object. Otherwise, the function fails in unpredictable ways.

For overlapped operations, DeviceIoControl returns immediately, and the event object is signaled when the operation has been completed. Otherwise, the function does not return until the operation has been completed or an error occurs.

Return value

If the operation completes successfully, DeviceIoControl returns a nonzero value.

If the operation fails or is pending, DeviceIoControl returns zero (0). To get extended error information, call GetLastError.

If the operation fails and GetLastError returns ERROR_MORE_DATA, the BufferSizeRequired member in the output buffer indicates how big a buffer is needed.

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

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

DeviceIoControl
TXFS_LIST_TRANSACTION_LOCKED_FILES
TXFS_LIST_TRANSACTION_LOCKED_FILES_ENTRY

 

 

Show: