FILE_RESTORE_FINISHED_INFORMATION structure

  • Article

Provides information about the final status of the restored file. This structure is used in RestoreFile and defines the format of the callback buffer for the FileRestoreFinished 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_FINISHED_INFORMATION {
  BOOL  Success;
  ULONG FinalResult;
  PVOID ClbkArg;
} FILE_RESTORE_FINISHED_INFORMATION, *PFILE_RESTORE_FINISHED_INFORMATION;

Members

Success

TRUE if the file was successfully restored; otherwise, FALSE.

FinalResult

The final error code that was returned by RestoreFile.

ClbkArg

The callback arguments that are passed with 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