CloudBlob.DownloadText Method (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 blob's contents, 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 options As BlobRequestOptions
Dim returnValue As String

returnValue = instance.DownloadText(options)

Syntax

Visual Basic
Public Function DownloadText ( _
	options As BlobRequestOptions _
) As String
C#
public string DownloadText (
	BlobRequestOptions options
)
C++
public:
String^ DownloadText (
	BlobRequestOptions^ options
)
J#
JScript

Parameters

options

Type: Microsoft.WindowsAzure.StorageClient.BlobRequestOptions

An object that specifies any additional options for the request.

Return Value

Type: System.String

The contents of the blob, as a string.

Example

The following code example downloads the contents of a publicly available blob using an anonymous client.

C# Copy Code
static void CreateAnonymousClient2(String blobEndpoint)
{
    // Create a service client for anonymous access to the Blob service.
    CloudBlobClient publicClient = new CloudBlobClient(blobEndpoint);

    // Get a reference to a blob in a public container.
    CloudBlob publicBlob = publicClient.GetBlobReference("mypubliccontainer/publicBlob.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);

    // Attempt to download the blob's contents.
    try
    {
        Console.WriteLine(publicBlob.DownloadText(options));
    }
    catch (StorageClientException e)
    {
        Console.WriteLine("Error code: ", e.ErrorCode);
        Console.WriteLine("Error message: ", e.Message);
    }
}

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