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 GetBackupSucceeded method returns the status of a complete attempt at backing up 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 GetBackupSucceeded(
[out] bool *pbSucceeded
);
Parameters
[out] pbSucceeded
The address of a caller-allocated variable that receives true if the backup was successful, or false otherwise.
Return value
The following are the valid return codes for this method.
| Value | Meaning |
|---|---|
|
Successfully returned the attribute value. |
|
The backup success state is undefined because the method was called prior to a BackupComplete event. |
|
One of the parameter values is not valid. |
|
The caller is out of memory or other system resources. |
|
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 not be called prior to a BackupComplete event, and is designed for use in an implementation of the event handler CVssWriter::OnBackupComplete.
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 |