Click or drag to resize
IVssBackupComponentsSetRangesFilePath Method
This method is used when a partial file operation requires a ranges file, and that file has been restored to a location other than its original one.

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

Parameters

writerId
Type: SystemGuid
Globally unique identifier (GUID) of the writer class containing the files involved in the partial file operation
componentType
Type: Alphaleonis.Win32.VssVssComponentType
Type of the component.
logicalPath
Type: SystemString

The logical path of the component containing the files that are participating in the partial file operation. 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 containing the files that are participating in the partial file operation.

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

partialFileIndex
Type: SystemInt32
Index number of the partial file. The value of this parameter is an integer between 0 and n-1, where n is the total number of partial files associated with a given component. The value of n is the number of items in PartialFiles.
rangesFile
Type: SystemString
The fully qualified path of a ranges file.
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.
NotSupportedExceptionThe operation is not supported by the current operating system.
Remarks
Calling SetRangesFilePath(Guid, VssComponentType, String, String, Int32, String) is not necessary if ranges files are restored in place.
Note Note
Windows XP and Windows Vista: This method requires Windows Server 2008 or Windows Server 2003
See Also