Share via


FILE_RESTORE_PROGRESS_INFORMATION structure

Provides information about the progress of the restoration of a file. This structure is used in the RestoreFile function and defines the format of the callback buffer for the FileRestoreProgressInfo message type.

Note

FMAPI can only be used in the Windows Preinstallation Environment (WinPE) for Windows Vista, Windows Server 2008, and later. Applications that use FMAPI must license WinPE.

Syntax

typedef struct _FILE_RESTORE_PROGRESS_INFORMATION {
  LONGLONG TotalFileSize;
  LONGLONG TotalBytesCompleted;
  LONGLONG StreamSize;
  LONGLONG StreamBytesCompleted;
  PVOID    ClbkArg;
} FILE_RESTORE_PROGRESS_INFORMATION, *PFILE_RESTORE_PROGRESS_INFORMATION;

Members

TotalFileSize

The total size of the restorable file, in bytes.

TotalBytesCompleted

The total number of bytes that have been restored.

StreamSize

The size of the current stream, in bytes.

StreamBytesCompleted

The number of bytes in the stream that have been restored.

ClbkArg

The callback arguments that are passed to RestoreFile.

Remarks

Note that there is no associated header file for this structure.

Requirements

Minimum supported client
Windows Vista [desktop apps only]
Minimum supported server
Windows Server 2008 [desktop apps only]

See also

RestoreFile