Share via


CloudFile.OpenRead Method

Definition

Opens a stream for reading from the file.

[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.IO.Stream OpenRead (Microsoft.Azure.Storage.AccessCondition accessCondition = default, Microsoft.Azure.Storage.File.FileRequestOptions options = default, Microsoft.Azure.Storage.OperationContext operationContext = default);
[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member OpenRead : Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.File.FileRequestOptions * Microsoft.Azure.Storage.OperationContext -> System.IO.Stream
override this.OpenRead : Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.File.FileRequestOptions * Microsoft.Azure.Storage.OperationContext -> System.IO.Stream
Public Overridable Function OpenRead (Optional accessCondition As AccessCondition = Nothing, Optional options As FileRequestOptions = Nothing, Optional operationContext As OperationContext = Nothing) As Stream

Parameters

accessCondition
AccessCondition

An AccessCondition object that represents the access conditions for the file. If null, no condition is used.

options
FileRequestOptions

A FileRequestOptions object that specifies additional options for the request.

operationContext
OperationContext

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

Returns

A stream to be used for reading from the file.

Attributes

Remarks

On the Stream object returned by this method, the EndRead(IAsyncResult) method must be called exactly once for every BeginRead(Byte[], Int32, Int32, AsyncCallback, Object) call. Failing to end a read process before beginning another read can cause unknown behavior.

Applies to