IVssBackupComponents::InitializeForBackup method

The InitializeForBackup method initializes the backup components metadata in preparation for backup.


HRESULT InitializeForBackup(
  BSTR bstrXML



Optional. During imports of transported shadow copies, this parameter must be the original document generated when creating the saved shadow copy and saved using 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 XML document is not valid. Check the event log for details. For more information, see Event and Error Handling Under VSS.
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.


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.

For more information on how to use InitializeForBackup with transportable shadow copies, see Importing Transportable Shadow Copied Volumes.


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

See Also