Click or drag to resize
IVssBackupComponentsSetRestoreOptions Method
Sets a string of private, or writer-dependent, restore parameters for a writer component.

Namespace: Alphaleonis.Win32.Vss
Assembly: AlphaVSS.Common (in AlphaVSS.Common.dll) Version: 1.3.0.0 (1.3.0.0)
Syntax
void SetRestoreOptions(
	Guid writerId,
	VssComponentType componentType,
	string logicalPath,
	string componentName,
	string restoreOptions
)

Parameters

writerId
Type: SystemGuid
Writer identifier.
componentType
Type: Alphaleonis.Win32.VssVssComponentType
Type of the component.
logicalPath
Type: SystemString

The logical path of the component. 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.

componentName
Type: SystemString

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).

restoreOptions
Type: SystemString
The private string of restore parameters. For more information see Setting VSS Restore Options.
Exceptions
ExceptionCondition
ArgumentNullExceptionOne of the arguments that cannot be was
ArgumentExceptionOne of the parameter values is not valid.
OutOfMemoryExceptionOut of memory or other system resources.
SystemExceptionUnexpected VSS system error. The error code is logged in the event log.
VssBadStateExceptionThe 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.
VssObjectNotFoundExceptionThe backup component does not exist.
VssInvalidXmlDocumentExceptionThe XML document is not valid. Check the event log for details.
Remarks

This method must be called before PreRestore.

The exact syntax and content of the restore options set by the restoreOptions parameter of the SetRestoreOptions(Guid, VssComponentType, String, String, String) method will depend on the specific writer being contacted.

See Also