ShareFileClient.OpenRead(ShareFileOpenReadOptions, CancellationToken) Method

Reference

Definition

Namespace:: Azure.Storage.Files.Shares

Assembly:: Azure.Storage.Files.Shares.dll

Package:: Azure.Storage.Files.Shares v12.18.0

Package:: Azure.Storage.Files.Shares v12.18.0-beta.2

Source:: ShareFileClient.cs

Source:: ShareFileClient.cs

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. The stream will only download the file as the stream is read from.

public virtual System.IO.Stream OpenRead (Azure.Storage.Files.Shares.Models.ShareFileOpenReadOptions options, System.Threading.CancellationToken cancellationToken = default);

abstract member OpenRead : Azure.Storage.Files.Shares.Models.ShareFileOpenReadOptions * System.Threading.CancellationToken -> System.IO.Stream
override this.OpenRead : Azure.Storage.Files.Shares.Models.ShareFileOpenReadOptions * System.Threading.CancellationToken -> System.IO.Stream

Public Overridable Function OpenRead (options As ShareFileOpenReadOptions, Optional cancellationToken As CancellationToken = Nothing) As Stream

Parameters

options: ShareFileOpenReadOptions

Optional parameters.

cancellationToken: CancellationToken

Optional CancellationToken to propagate notifications that the operation should be cancelled.

Returns

Stream

Returns a stream that will download the file as the stream is read from.

Remarks

The stream returned might throw ShareFileModifiedException if the file is concurrently modified and ShareFileOpenReadOptions don't allow modification.

A RequestFailedException will be thrown if other failures occur.

Applies to

Share via