CloudFile.OpenRead Method

Definition

Namespace:: Microsoft.Azure.Storage.File

Assembly:: Microsoft.Azure.Storage.File.dll

Package:: Microsoft.Azure.Storage.File v11.2.3

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

System.IO.Stream

A stream to be used for reading from the file.

Attributes: DoesServiceRequestAttribute

Remarks

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

Applies to