CloudBlob.DownloadToStream Method (Stream, BlobRequestOptions)

Storage Client Library NET API

[This topic is part of the Microsoft Azure Storage Client Library 1.7, which has been deprecated. See Storage Client Library for the latest version.]

Downloads the contents of a blob to a stream, using a conditional request based on the BlobRequestOptions that you specify.

Namespace: Microsoft.WindowsAzure.StorageClient
Assembly: Microsoft.WindowsAzure.StorageClient (in Microsoft.WindowsAzure.StorageClient.dll)

Usage

Visual Basic
Dim instance As CloudBlob
Dim target As Stream
Dim options As BlobRequestOptions

instance.DownloadToStream(target, options)

Syntax

Visual Basic
Public Sub DownloadToStream ( _
	target As Stream, _
	options As BlobRequestOptions _
)
C#
public void DownloadToStream (
	Stream target,
	BlobRequestOptions options
)
C++
public:
void DownloadToStream (
	Stream^ target, 
	BlobRequestOptions^ options
)
J#
JScript

Parameters

target

Type: System.IO.Stream

The target stream.

options

Type: Microsoft.WindowsAzure.StorageClient.BlobRequestOptions

An object that specifies any additional options for the request.

Example

The following code example appends the contents of a text blob to a local text file—and specifies a 20 second timeout on the operation.

C# Copy Code
static void AppendTextBlobToFile2(Uri blobEndpoint, string accountName, string accountKey)
{
    // Create service client for credentialed access to the Blob service.
    CloudBlobClient blobClient = new CloudBlobClient(blobEndpoint, new StorageCredentialsAccountAndKey(accountName, accountKey));

    // Get a reference to a blob.
    CloudBlob blob = blobClient.GetBlobReference("mycontainer/myblob.txt");

    // Set options for the request. E.g., Specify an operation timeout of 20 seconds.
    BlobRequestOptions options = new BlobRequestOptions();

    options.Timeout = TimeSpan.FromSeconds(20.0);

    // Download the blob to a file stream.
    FileStream stream = new FileStream("C:\\appendtofile.txt", FileMode.Append);

    blob.DownloadToStream(stream, options);
}

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

Windows Vista, Windows 7, Windows Server 2008, Windows 8.1, Windows Server 2012 R2, Windows 8 and Windows Server 2012

Change History

See Also