IVssBackupComponents::SetAdditionalRestores method (vsbackup.h)
The SetAdditionalRestores method is used by a requester during incremental or differential restore operations to indicate to writers that a given component will require additional restore operations to completely retrieve it.
Syntax
HRESULT SetAdditionalRestores(
[in] VSS_ID writerId,
[in] VSS_COMPONENT_TYPE ct,
[in] LPCWSTR wszLogicalPath,
[in] LPCWSTR wszComponentName,
[in] bool bAdditionalRestores
);
Parameters
[in] writerId
Writer identifier.
[in] ct
Type of the component. See VSS_COMPONENT_TYPE for the possible values.
[in] wszLogicalPath
Null-terminated wide character string containing the logical path of the component to be added.
For more information, see Logical Pathing of Components.
The value of the string containing the logical path used here should be the same as was used when the component was added to the backup set using IVssBackupComponents::AddComponent.
The logical path can be NULL.
There are no restrictions on the characters that can appear in a non-NULL logical path.
[in] wszComponentName
Null-terminated wide character string containing the name of the component.
The value of the string should not be NULL, and should contain the same component as was used when the component was added to the backup set using IVssBackupComponents::AddComponent.
[in] bAdditionalRestores
If the value of this parameter is true, additional restores of the component will follow this restore. If the value is false, additional restores of the component will not follow this restore.
Return value
The following are the valid return codes for this method.
| Value | Meaning |
|---|---|
|
Successfully set the additional restore status. |
|
One of the parameter values is not valid. |
|
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 backup component does not exist. |
|
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. |
Remarks
The information provided by the SetAdditionalRestores method is typically used by writers that support an explicit recovery mechanism as part of their PostRestore event handler (CVssWriter::OnPostRestore)—for instance, the Exchange Server, and database applications such as SQL Server. For these applications, it is often not possible to perform additional differential, incremental, or log restores after such a recovery is performed.
Therefore, if SetAdditionalRestores for a component is set to true, this means that such a writer should not execute its explicit recovery mechanism and should expect that additional differential, incremental, or log restores will be done.
When SetAdditionalRestores on a component is set to false, then after the component is restored, the application can complete its recovery operation and be brought back online.
This method must be called before IVssBackupComponents::PreRestore.
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 |