CloudFile.DownloadTextAsync 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.

Overloads

DownloadTextAsync()	Returns a task that performs an asynchronous operation to download the file's contents as a string.
DownloadTextAsync(CancellationToken)	Returns a task that performs an asynchronous operation to download the file's contents as a string.
DownloadTextAsync(Encoding, AccessCondition, FileRequestOptions, OperationContext)	Returns a task that performs an asynchronous operation to download the file's contents as a string.
DownloadTextAsync(Encoding, AccessCondition, FileRequestOptions, OperationContext, CancellationToken)	Returns a task that performs an asynchronous operation to download the file's contents as a string.
DownloadTextAsync(Encoding, AccessCondition, FileRequestOptions, OperationContext, IProgress<StorageProgress>, CancellationToken)	Returns a task that performs an asynchronous operation to download the file's contents as a string.

DownloadTextAsync()

Returns a task that performs an asynchronous operation to download the file's contents as a string.

[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task<string> DownloadTextAsync();

[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member DownloadTextAsync : unit -> System.Threading.Tasks.Task<string>
override this.DownloadTextAsync : unit -> System.Threading.Tasks.Task<string>

Public Overridable Function DownloadTextAsync () As Task(Of String)

Returns

System.Threading.Tasks.Task<System.String>

A System.Threading.Tasks.Task object that represents the current operation.

Attributes: DoesServiceRequestAttribute

Applies to

DownloadTextAsync(CancellationToken)

Returns a task that performs an asynchronous operation to download the file's contents as a string.

[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task<string> DownloadTextAsync(System.Threading.CancellationToken cancellationToken);

[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member DownloadTextAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<string>
override this.DownloadTextAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<string>

Public Overridable Function DownloadTextAsync (cancellationToken As CancellationToken) As Task(Of String)

Parameters

cancellationToken: System.Threading.CancellationToken

A System.Threading.CancellationToken to observe while waiting for a task to complete.

Returns

System.Threading.Tasks.Task<System.String>

A System.Threading.Tasks.Task object that represents the current operation.

Attributes: DoesServiceRequestAttribute

Applies to

DownloadTextAsync(Encoding, AccessCondition, FileRequestOptions, OperationContext)

Returns a task that performs an asynchronous operation to download the file's contents as a string.

[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task<string> DownloadTextAsync(System.Text.Encoding encoding, Microsoft.Azure.Storage.AccessCondition accessCondition, Microsoft.Azure.Storage.File.FileRequestOptions options, Microsoft.Azure.Storage.OperationContext operationContext);

[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member DownloadTextAsync : System.Text.Encoding * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.File.FileRequestOptions * Microsoft.Azure.Storage.OperationContext -> System.Threading.Tasks.Task<string>
override this.DownloadTextAsync : System.Text.Encoding * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.File.FileRequestOptions * Microsoft.Azure.Storage.OperationContext -> System.Threading.Tasks.Task<string>

Public Overridable Function DownloadTextAsync (encoding As Encoding, accessCondition As AccessCondition, options As FileRequestOptions, operationContext As OperationContext) As Task(Of String)

Parameters

encoding: System.Text.Encoding

A System.Text.Encoding object that indicates the type of text encoding to use.

accessCondition: AccessCondition

An AccessCondition object that represents the access conditions for the file.

options: FileRequestOptions

An FileRequestOptions object that specifies additional options for the request.

operationContext: OperationContext

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

Returns

System.Threading.Tasks.Task<System.String>

A System.Threading.Tasks.Task object that represents the current operation.

Attributes: DoesServiceRequestAttribute

Applies to

DownloadTextAsync(Encoding, AccessCondition, FileRequestOptions, OperationContext, CancellationToken)

Returns a task that performs an asynchronous operation to download the file's contents as a string.

[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task<string> DownloadTextAsync(System.Text.Encoding encoding, Microsoft.Azure.Storage.AccessCondition accessCondition, Microsoft.Azure.Storage.File.FileRequestOptions options, Microsoft.Azure.Storage.OperationContext operationContext, System.Threading.CancellationToken cancellationToken);

[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member DownloadTextAsync : System.Text.Encoding * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.File.FileRequestOptions * Microsoft.Azure.Storage.OperationContext * System.Threading.CancellationToken -> System.Threading.Tasks.Task<string>
override this.DownloadTextAsync : System.Text.Encoding * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.File.FileRequestOptions * Microsoft.Azure.Storage.OperationContext * System.Threading.CancellationToken -> System.Threading.Tasks.Task<string>

Public Overridable Function DownloadTextAsync (encoding As Encoding, accessCondition As AccessCondition, options As FileRequestOptions, operationContext As OperationContext, cancellationToken As CancellationToken) As Task(Of String)

Parameters

encoding: System.Text.Encoding

A System.Text.Encoding object that indicates the type of text encoding to use.

accessCondition: AccessCondition

An AccessCondition object that represents the access conditions for the file.

options: FileRequestOptions

An FileRequestOptions object that specifies additional options for the request.

operationContext: OperationContext

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

cancellationToken: System.Threading.CancellationToken

A System.Threading.CancellationToken to observe while waiting for a task to complete.

Returns

System.Threading.Tasks.Task<System.String>

A System.Threading.Tasks.Task object that represents the current operation.

Attributes: DoesServiceRequestAttribute

Applies to

DownloadTextAsync(Encoding, AccessCondition, FileRequestOptions, OperationContext, IProgress<StorageProgress>, CancellationToken)

Returns a task that performs an asynchronous operation to download the file's contents as a string.

[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task<string> DownloadTextAsync(System.Text.Encoding encoding, Microsoft.Azure.Storage.AccessCondition accessCondition, Microsoft.Azure.Storage.File.FileRequestOptions options, Microsoft.Azure.Storage.OperationContext operationContext, IProgress<Microsoft.Azure.Storage.Core.Util.StorageProgress> progressHandler, System.Threading.CancellationToken cancellationToken);

[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member DownloadTextAsync : System.Text.Encoding * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.File.FileRequestOptions * Microsoft.Azure.Storage.OperationContext * IProgress<Microsoft.Azure.Storage.Core.Util.StorageProgress> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<string>
override this.DownloadTextAsync : System.Text.Encoding * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.File.FileRequestOptions * Microsoft.Azure.Storage.OperationContext * IProgress<Microsoft.Azure.Storage.Core.Util.StorageProgress> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<string>

Public Overridable Function DownloadTextAsync (encoding As Encoding, accessCondition As AccessCondition, options As FileRequestOptions, operationContext As OperationContext, progressHandler As IProgress(Of StorageProgress), cancellationToken As CancellationToken) As Task(Of String)

Parameters

encoding: System.Text.Encoding

A System.Text.Encoding object that indicates the type of text encoding to use.

accessCondition: AccessCondition

An AccessCondition object that represents the access conditions for the file.

options: FileRequestOptions

An FileRequestOptions object that specifies additional options for the request.

operationContext: OperationContext

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

progressHandler: System.IProgress<StorageProgress>

A System.IProgress`1 object to handle StorageProgress messages.

cancellationToken: System.Threading.CancellationToken

A System.Threading.CancellationToken to observe while waiting for a task to complete.

Returns

System.Threading.Tasks.Task<System.String>

A System.Threading.Tasks.Task object that represents the current operation.

Attributes: DoesServiceRequestAttribute

Applies to