Click or drag to resize
IVssBackupComponentsAddAlternativeLocationMapping Method
The AddAlternativeLocationMapping method is used by a requester to indicate that an alternate location mapping was used to restore all the members of a file set in a given component.

Namespace: Alphaleonis.Win32.Vss
Assembly: AlphaVSS.Common (in AlphaVSS.Common.dll) Version: 1.3.0.0 (1.3.0.0)
Syntax
void AddAlternativeLocationMapping(
	Guid writerId,
	VssComponentType componentType,
	string logicalPath,
	string componentName,
	string path,
	string filespec,
	bool recursive,
	string destination
)

Parameters

writerId
Type: SystemGuid
Globally unique identifier (GUID) of the writer class that exported the component.
componentType
Type: Alphaleonis.Win32.VssVssComponentType
Type of the component.
logicalPath
Type: SystemString

String containing the logical path to the component. 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 component name.
path
Type: SystemString

The path to the directory that originally contained the file to be relocated. This path must be local to the VSS machine.

The path can contain environment variables (for example, %SystemRoot%) but cannot contain wildcard characters. UNC paths are not supported.

There is no requirement that the path end with a backslash ("\"). It is up to applications that retrieve this information to check.

filespec
Type: SystemString
String containing the original file specification. A file specification cannot contain directory specifications (for example, no backslashes) but can contain the ? and * wildcard characters.
recursive
Type: SystemBoolean
Boolean indicating whether the path specified by the path parameter identifies only a single directory or if it indicates a hierarchy of directories to be traversed recursively. The Boolean is true if the path is treated as a hierarchy of directories to be traversed recursively and false if not.
destination
Type: SystemString
The name of the directory where the file will be relocated. This path must be local to the VSS machine. UNC paths are not supported.
Exceptions
ExceptionCondition
ArgumentExceptionOne of the parameters 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.
VssInvalidXmlDocumentExceptionThe XML document is not valid. Check the event log for details.
VssObjectNotFoundExceptionThe specified component does not exist.
See Also