This function downloads a stream on the virtual cluster to the local machine. The download will start at the specified offset and copy "length" number of bytes.

Namespace: Microsoft.Cosmos.Management
Assembly: VcClient (in VcClient.dll) Version: 1.0.0.0 (1.8.400.4142)

Syntax

C#
public void Download(
	CosmosUri sourceStream,
	string destinationFile,
	long offset,
	long length,
	bool compression,
	DownloadMode downloadMode
)
Visual Basic
Public Sub Download ( _
	sourceStream As CosmosUri, _
	destinationFile As String, _
	offset As Long, _
	length As Long, _
	compression As Boolean, _
	downloadMode As DownloadMode _
)
Visual C++
public:
void Download(
	CosmosUri^ sourceStream, 
	String^ destinationFile, 
	long long offset, 
	long long length, 
	bool compression, 
	DownloadMode downloadMode
)

Parameters

sourceStream
Type: CosmosUri
Complete path of the stream in vc:// or http:// format.
destinationFile
Type: String
The path/name of the file where the stream needs to be copied to.
offset
Type: Int64
The position in the stream from which the stream should be copied.
length
Type: Int64
The number of bytes to be read.
compression
Type: Boolean
Whether compression should be used while transferring data from the VC.
downloadMode
Type: VcClient..::..DownloadMode
If the file being downloaded already exists, this Specifies if a file needs to be overwritten, appended, or throw exception.

See Also