Edit

Share via

FSCTL_TXFS_QUERY_RM_INFORMATION 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.

Retrieves information for a resource manager (RM).

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

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

Remarks

FSCTL_TXFS_QUERY_RM_INFORMATION is a synchronous operation.

If this call fails with ERROR_BUFFER_TOO_SMALL, the BytesRequired member of the TXFS_QUERY_RM_INFORMATION structure specifies how large the buffer must be for the call to return successfully.

If you are writing an application that supports remote Server Message Block Protocol clients, you must use this control code to use the resource manager.

The resource manager may be queried regardless of its state; if the RM is not started, ERROR_RM_NOT_ACTIVE is returned. You can use the information about the active range of the log to guide decisions about how much of the log to archive.

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