FILE_RESTORE_CALLBACK function pointer
The FILE_RESTORE_CALLBACK function describes a callback function that is used to report the progress status or finished status of the file restoration process.
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 BOOLEAN ( *FILE_RESTORE_CALLBACK)(
_In_ FILE_RESTORE_PACKET_TYPE PacketType,
_In_ ULONG PacketLength,
_In_ PVOID PacketData
);
Parameters
-
PacketType [in]
-
The message type that is sent. For more information, see the FILE_RESTORE_PACKET_TYPE enumeration.
-
PacketLength [in]
-
The length of the information in the packet, in bytes.
-
PacketData [in]
-
The progress status or finished status of the file restoration process.
Return value
If the callback returns FALSE, the file restore operation is canceled.
Remarks
Note that there is no associated header file for this callback function.
Requirements
| Minimum supported client |
Windows Vista [desktop apps only] |
| Minimum supported server |
Windows Server 2008 [desktop apps only] |