Click or drag to resize
IVssBackupComponentsSetSelectedForRestore Method (Guid, VssComponentType, String, String, Boolean)
Indicates whether the specified selectable component is selected for restoration.

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

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

selectedForRestore
Type: SystemBoolean
If the value of this parameter is , the selected component has been selected for restoration. If the value is , the selected component has not been selected for restoration.
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

SetSelectedForRestore has meaning only for restores taking place in component mode.

SetSelectedForRestore Overload can only be called for components that were explicitly added to the backup document at backup time using AddComponent(Guid, Guid, VssComponentType, String, String). Restoring a component that was implicitly selected for backup as part of a component set must be done by calling SetSelectedForRestore Overload on the closest ancestor component that was added to the document. If only this component's data is to be restored, that should be accomplished through AddRestoreSubcomponent(Guid, VssComponentType, String, String, String, String); this can only be done if the component is selectable for restore.

This method must be called before PreRestore.

See Also