Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
The GetFileRestoreStatus method returns the status of a completed attempt to restore all the files of a selected component or component set as a VSS_FILE_RESTORE_STATUS enumeration. (See Working with Selectability and Logical Paths for information on selecting components.)
Either a writer or a requester can call this method.
Syntax
HRESULT GetFileRestoreStatus(
[out] VSS_FILE_RESTORE_STATUS *pStatus
);
Parameters
[out] pStatus
The address of a caller-allocated variable that receives a VSS_FILE_RESTORE_STATUS enumeration value that specifies whether all files were successfully restored.
Return value
The following are the valid return codes for this method.
| Value | Meaning |
|---|---|
|
Successfully returned the attribute value. |
|
One of the parameter values is not valid. |
|
The caller is out of memory or other system resources. |
|
The method was not called as part of a restore operation. |
|
The XML document is not valid. Check the event log for details. For more information, see Event and Error Handling Under VSS. |
Remarks
This method should be called only following a PostRestore event.
The status returned is undefined if this method is applied to a component that has not been selected for restore by being added to the Backup Components via IVssBackupComponents::AddComponent.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows XP [desktop apps only] |
| Minimum supported server | Windows Server 2003 [desktop apps only] |
| Target Platform | Windows |
| Header | vswriter.h (include Vss.h, VsWriter.h) |
| Library | VssApi.lib |