CloudFile.DownloadTextAsync Method

Definition

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.WindowsAzure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task<string> DownloadTextAsync ();
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

Task<String>

A Task object that represents the current operation.

Attributes

Applies to

Product Introduced

DownloadTextAsync(CancellationToken)

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

[Microsoft.WindowsAzure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task<string> DownloadTextAsync (System.Threading.CancellationToken cancellationToken);
abstract member DownloadTextAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<string>
override this.DownloadTextAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<string>

Parameters

cancellationToken
CancellationToken

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

Returns

Task<String>

A Task object that represents the current operation.

Attributes

Applies to

Product Introduced

DownloadTextAsync(Encoding, AccessCondition, FileRequestOptions, OperationContext)

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

[Microsoft.WindowsAzure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task<string> DownloadTextAsync (System.Text.Encoding encoding, Microsoft.WindowsAzure.Storage.AccessCondition accessCondition, Microsoft.WindowsAzure.Storage.File.FileRequestOptions options, Microsoft.WindowsAzure.Storage.OperationContext operationContext);
abstract member DownloadTextAsync : System.Text.Encoding * Microsoft.WindowsAzure.Storage.AccessCondition * Microsoft.WindowsAzure.Storage.File.FileRequestOptions * Microsoft.WindowsAzure.Storage.OperationContext -> System.Threading.Tasks.Task<string>
override this.DownloadTextAsync : System.Text.Encoding * Microsoft.WindowsAzure.Storage.AccessCondition * Microsoft.WindowsAzure.Storage.File.FileRequestOptions * Microsoft.WindowsAzure.Storage.OperationContext -> System.Threading.Tasks.Task<string>

Parameters

encoding
Encoding

A 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

Task<String>

A Task object that represents the current operation.

Attributes

Applies to

Product Introduced

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

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

[Microsoft.WindowsAzure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task<string> DownloadTextAsync (System.Text.Encoding encoding, Microsoft.WindowsAzure.Storage.AccessCondition accessCondition, Microsoft.WindowsAzure.Storage.File.FileRequestOptions options, Microsoft.WindowsAzure.Storage.OperationContext operationContext, System.Threading.CancellationToken cancellationToken);
abstract member DownloadTextAsync : System.Text.Encoding * Microsoft.WindowsAzure.Storage.AccessCondition * Microsoft.WindowsAzure.Storage.File.FileRequestOptions * Microsoft.WindowsAzure.Storage.OperationContext * System.Threading.CancellationToken -> System.Threading.Tasks.Task<string>
override this.DownloadTextAsync : System.Text.Encoding * Microsoft.WindowsAzure.Storage.AccessCondition * Microsoft.WindowsAzure.Storage.File.FileRequestOptions * Microsoft.WindowsAzure.Storage.OperationContext * System.Threading.CancellationToken -> System.Threading.Tasks.Task<string>

Parameters

encoding
Encoding

A 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
CancellationToken

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

Returns

Task<String>

A Task object that represents the current operation.

Attributes

Applies to

Product Introduced

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.WindowsAzure.Storage.DoesServiceRequest]
public virtual System.Threading.Tasks.Task<string> DownloadTextAsync (System.Text.Encoding encoding, Microsoft.WindowsAzure.Storage.AccessCondition accessCondition, Microsoft.WindowsAzure.Storage.File.FileRequestOptions options, Microsoft.WindowsAzure.Storage.OperationContext operationContext, IProgress<Microsoft.WindowsAzure.Storage.Core.Util.StorageProgress> progressHandler, System.Threading.CancellationToken cancellationToken);
abstract member DownloadTextAsync : System.Text.Encoding * Microsoft.WindowsAzure.Storage.AccessCondition * Microsoft.WindowsAzure.Storage.File.FileRequestOptions * Microsoft.WindowsAzure.Storage.OperationContext * IProgress<Microsoft.WindowsAzure.Storage.Core.Util.StorageProgress> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<string>
override this.DownloadTextAsync : System.Text.Encoding * Microsoft.WindowsAzure.Storage.AccessCondition * Microsoft.WindowsAzure.Storage.File.FileRequestOptions * Microsoft.WindowsAzure.Storage.OperationContext * IProgress<Microsoft.WindowsAzure.Storage.Core.Util.StorageProgress> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<string>

Parameters

encoding
Encoding

A 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
IProgress<StorageProgress>

A IProgress<T> object to handle StorageProgress messages.

cancellationToken
CancellationToken

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

Returns

Task<String>

A Task object that represents the current operation.

Attributes

Applies to

Product Introduced