CloudBlockBlob.DownloadToByteArray Method

Article
05/14/2014

Downloads the contents of a blob to a byte array.

Namespace: Microsoft.WindowsAzure.Storage.Blob
Assembly: Microsoft.WindowsAzure.Storage (in Microsoft.WindowsAzure.Storage.dll)

Syntax

'Declaration
<DoesServiceRequestAttribute> _
Public Function DownloadToByteArray ( _
    target As Byte(), _
    index As Integer, _
    <OptionalAttribute> Optional accessCondition As AccessCondition = Nothing, _
    <OptionalAttribute> Optional options As BlobRequestOptions = Nothing, _
    <OptionalAttribute> Optional operationContext As OperationContext = Nothing _
) As Integer

[DoesServiceRequestAttribute] 
public int DownloadToByteArray (
    byte[] target,
    int index,
    [OptionalAttribute] AccessCondition accessCondition,
    [OptionalAttribute] BlobRequestOptions options,
    [OptionalAttribute] OperationContext operationContext
)

[DoesServiceRequestAttribute] 
public:
virtual int DownloadToByteArray (
    array<unsigned char>^ target, 
    int index, 
    [OptionalAttribute] AccessCondition^ accessCondition, 
    [OptionalAttribute] BlobRequestOptions^ options, 
    [OptionalAttribute] OperationContext^ operationContext
) sealed

Parameters

target
The target byte array.

index
The starting offset in the byte array.

accessCondition
An AccessCondition object that represents the condition that must be met in order for the request to proceed.

options
A BlobRequestOptions object that specifies additional options for the request. If null, default options are applied to the request.

operationContext
An OperationContext object that represents the context for the current operation.

Return Value

The total number of bytes read into the buffer.

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 and Windows Server 2008