IVssBackupComponents::InitializeForRestore method (vsbackup.h)
The InitializeForRestore method initializes the IVssBackupComponents interface in preparation for a restore operation.
Syntax
HRESULT InitializeForRestore(
[in] BSTR bstrXML
);
Parameters
[in] bstrXML
XML string containing the Backup Components Document generated by a backup operation and saved by IVssBackupComponents::SaveAsXML.
Return value
The following are the valid return codes for this method.
| Value | Meaning |
|---|---|
|
Successfully initialized the specified document for backup. |
|
The caller does not have sufficient backup privileges or is not an administrator. |
|
The caller is out of memory or other system resources. |
|
The backup components object is not initialized, this method has been called during a restore operation, or this method has not been called within the correct sequence. |
|
The load operation of the specified XML document failed. |
|
Unexpected error. The error code is logged in the error log file. For more information, see
Event and Error Handling Under VSS.
Windows Server 2008, Windows Vista, Windows Server 2003 and Windows XP: This value is not supported until Windows Server 2008 R2 and Windows 7. E_UNEXPECTED is used instead. |
Remarks
The XML document supplied to this method initializes the IVssBackupComponents object with metadata previously stored by a call to IVssBackupComponents::SaveAsXML. Users should not tamper with this metadata document.
Requirements
| Requirement | Value |
|---|---|
| Minimum supported client | Windows XP [desktop apps only] |
| Minimum supported server | Windows Server 2003 [desktop apps only] |
| Target Platform | Windows |
| Header | vsbackup.h (include VsBackup.h, Vss.h, VsWriter.h) |
| Library | VssApi.lib |