FSCTL_TXFS_READ_BACKUP_INFORMATION IOCTL

Description

[!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 Transactional NTFS (TxF) specific information for the specified file.

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

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

Parameters

Input buffer

Input buffer length

Output buffer

Output buffer length

Input/output buffer

Input/output buffer length

Status block

Irp->IoStatus.Status is set to STATUS_SUCCESS if the request is successful.

Otherwise, Status to the appropriate error condition as a NTSTATUS code.

For more information, see NTSTATUS Values.

Remarks

FSCTL_TXFS_READ_BACKUP_INFORMATION is a synchronous operation.

This control code can be used by backup functions and applications, such as Win32 BackupRead, and by Volume Shadow Copy Service (VSS) writers that support secondary resource managers. For more information, see Volume Shadow Copy Service.

ReFS: This code is not supported.

See also

• DeviceIoControl
• TXFS_READ_BACKUP_INFORMATION_OUT
• Volume Shadow Copy Service