This function downloads a stream on the virtual cluster to the local machine. The download will start at the specified
offset and copy until the end of the stream.
Namespace: VcClientAssembly: VcClient (in VcClient.dll) Version: 1.0.0.0 (1.8.400.4142)
Syntax
C# |
---|
public static void Download(
string sourceStream,
string destinationFile,
long offset,
bool compression,
bool overwrite
) |
Visual Basic |
---|
Public Shared Sub Download ( _
sourceStream As String, _
destinationFile As String, _
offset As Long, _
compression As Boolean, _
overwrite As Boolean _
) |
Visual C++ |
---|
public:
static void Download(
String^ sourceStream,
String^ destinationFile,
long long offset,
bool compression,
bool overwrite
) |
Parameters
- sourceStream
- Type: String
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.
- compression
- Type: Boolean
Whether compression should be used while transferring data from the VC.
- overwrite
- Type: Boolean
Passing true for this parameter will delete the destination file if it exists. Passing false
will throw an exception, if the destination file already exists.
See Also