Storage Client Library for Windows Phone (Version 7.0)

Initiates an asynchronous operation to open a stream for reading from the blob.

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

Syntax

C#

Copy Code

 

[DoesServiceRequestAttribute]
public virtual Task<Stream> OpenReadAsync(
	AccessCondition accessCondition,
	BlobRequestOptions options,
	OperationContext operationContext
)

C++

Copy Code

 

public:
[DoesServiceRequestAttribute]
virtual Task<Stream^>^ OpenReadAsync(
	AccessCondition^ accessCondition,
	BlobRequestOptions^ options,
	OperationContext^ operationContext
)

F#

Copy Code

 

[<DoesServiceRequestAttribute>]
abstract OpenReadAsync : 
        accessCondition:AccessCondition *
        options:BlobRequestOptions *
        operationContext:OperationContext -> Task<Stream>
[<DoesServiceRequestAttribute>]
override OpenReadAsync : 
        accessCondition:AccessCondition *
        options:BlobRequestOptions *
        operationContext:OperationContext -> Task<Stream>

VB

Copy Code

 

<DoesServiceRequestAttribute>
Public Overridable Function OpenReadAsync (
	accessCondition As AccessCondition,
	options As BlobRequestOptions,
	operationContext As OperationContext
) As Task(Of Stream)

Parameters

accessCondition

Type: Microsoft.WindowsAzure.Storage.AccessConditionMicrosoft.WindowsAzure.Storage::AccessCondition^Microsoft.WindowsAzure.Storage.AccessConditionMicrosoft.WindowsAzure.Storage.AccessCondition

An AccessCondition object that represents the condition that must be met in order for the request to proceed. If null, no condition is used.

options

Type: Microsoft.WindowsAzure.Storage.Blob.BlobRequestOptionsMicrosoft.WindowsAzure.Storage.Blob::BlobRequestOptions^Microsoft.WindowsAzure.Storage.Blob.BlobRequestOptionsMicrosoft.WindowsAzure.Storage.Blob.BlobRequestOptions

A BlobRequestOptions object that specifies additional options for the request.

operationContext

Type: Microsoft.WindowsAzure.Storage.OperationContextMicrosoft.WindowsAzure.Storage::OperationContext^Microsoft.WindowsAzure.Storage.OperationContextMicrosoft.WindowsAzure.Storage.OperationContext

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

Return Value

Type: System.Threading.Tasks.Task<Stream>System.Threading.Tasks::Task<Stream^>^System.Threading.Tasks.Task<Stream>System.Threading.Tasks.Task(Of Stream)

A Task<TResult><TResult><'TResult>(Of TResult) object of type Stream that represents the asynchronous operation.

Remarks

On the Stream object returned by this method, the EndRead method must be called exactly once for every BeginRead call. Failing to end the read process before beginning another read process can cause unexpected behavior.

Note that this method always makes a call to the FetchAttributesAsync method under the covers.

Set the StreamMinimumReadSizeInBytesStreamMinimumReadSizeInBytesStreamMinimumReadSizeInBytesStreamMinimumReadSizeInBytes property before calling this method to specify the minimum number of bytes to buffer when reading from the stream. The value must be at least 16 KB.

See Also

OpenReadAsync Overload
CloudBlob Class
Microsoft.WindowsAzure.Storage.Blob Namespace

Return to top