Storage Client Library for Windows Phone (Version 7.0)

Begins 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 ICancellableAsyncResult BeginOpenRead(
	AccessCondition accessCondition,
	BlobRequestOptions options,
	OperationContext operationContext,
	AsyncCallback callback,
	object state
)

C++

Copy Code

 

public:
[DoesServiceRequestAttribute]
virtual ICancellableAsyncResult^ BeginOpenRead(
	AccessCondition^ accessCondition,
	BlobRequestOptions^ options,
	OperationContext^ operationContext,
	AsyncCallback^ callback,
	Object^ state
)

F#

Copy Code

 

[<DoesServiceRequestAttribute>]
abstract BeginOpenRead : 
        accessCondition:AccessCondition *
        options:BlobRequestOptions *
        operationContext:OperationContext *
        callback:AsyncCallback *
        state:Object -> ICancellableAsyncResult
[<DoesServiceRequestAttribute>]
override BeginOpenRead : 
        accessCondition:AccessCondition *
        options:BlobRequestOptions *
        operationContext:OperationContext *
        callback:AsyncCallback *
        state:Object -> ICancellableAsyncResult

VB

Copy Code

 

<DoesServiceRequestAttribute>
Public Overridable Function BeginOpenRead (
	accessCondition As AccessCondition,
	options As BlobRequestOptions,
	operationContext As OperationContext,
	callback As AsyncCallback,
	state As Object
) As ICancellableAsyncResult

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.

callback

Type: System.AsyncCallbackSystem::AsyncCallback^System.AsyncCallbackSystem.AsyncCallback

An AsyncCallback delegate that will receive notification when the asynchronous operation completes.

state

Type: System.ObjectSystem::Object^System.ObjectSystem.Object

A user-defined object that will be passed to the callback delegate.

Return Value

Type: Microsoft.WindowsAzure.Storage.ICancellableAsyncResultMicrosoft.WindowsAzure.Storage::ICancellableAsyncResult^Microsoft.WindowsAzure.Storage.ICancellableAsyncResultMicrosoft.WindowsAzure.Storage.ICancellableAsyncResult

An ICancellableAsyncResult that references the asynchronous operation.

Remarks

On the Stream object returned by the EndOpenRead 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 BeginFetchAttributes 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

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

Return to top