IVssBackupComponentsSetBackupOptions Method |
Namespace: Alphaleonis.Win32.Vss
void SetBackupOptions( Guid writerId, VssComponentType componentType, string logicalPath, string componentName, string backupOptions )
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 AddComponent(Guid, Guid, VssComponentType, String, String).
The logical path can be .
There are no restrictions on the characters that can appear in a non-null logical path.
The name of the component.
The value of the string should not be , and should contain the same component as was used when the component was added to the backup set using AddComponent(Guid, Guid, VssComponentType, String, String).
Exception | Condition |
---|---|
ArgumentNullException | One of the arguments that cannot be was |
ArgumentException | One of the parameter values is not valid. |
OutOfMemoryException | Out of memory or other system resources. |
SystemException | Unexpected VSS system error. The error code is logged in the event log. |
VssBadStateException | 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. |
VssObjectNotFoundException | The backup component does not exist. |
VssInvalidXmlDocumentException | The XML document is not valid. Check the event log for details. |
The exact syntax and content of the backup options set by the wszBackupOptions parameter of the SetBackupOptions(Guid, VssComponentType, String, String, String) method will depend on the specific writer being contacted.
This method must be called before PrepareForBackup.