CloudBlockBlob.DownloadTextAsync Method
Definition
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(CancellationToken) |
Initiates an asynchronous operation to download the blob's contents as a string. |
| DownloadTextAsync(Encoding, AccessCondition, BlobRequestOptions, OperationContext, IProgress<StorageProgress>, CancellationToken) |
Initiates an asynchronous operation to download the blob's contents as a string. |
| DownloadTextAsync(Encoding, AccessCondition, BlobRequestOptions, OperationContext, CancellationToken) |
Initiates an asynchronous operation to download the blob's contents as a string. |
| DownloadTextAsync() |
Initiates an asynchronous operation to download the blob's contents as a string. |
| DownloadTextAsync(Encoding, AccessCondition, BlobRequestOptions, OperationContext) |
Initiates an asynchronous operation to download the blob's contents as a string. |
DownloadTextAsync(CancellationToken)
Initiates an asynchronous operation to download the blob'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
- CancellationToken
A CancellationToken to observe while waiting for a task to complete.
Returns
A Task<TResult> object of type string that represents the asynchronous operation.
- Attributes
Applies to
DownloadTextAsync(Encoding, AccessCondition, BlobRequestOptions, OperationContext, IProgress<StorageProgress>, CancellationToken)
Initiates an asynchronous operation to download the blob'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.Blob.BlobRequestOptions 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.Blob.BlobRequestOptions * 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.Blob.BlobRequestOptions * 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 BlobRequestOptions, operationContext As OperationContext, progressHandler As IProgress(Of StorageProgress), cancellationToken As CancellationToken) As Task(Of String)Parameters
- encoding
- Encoding
An object that indicates the text encoding to use.
- accessCondition
- AccessCondition
An AccessCondition object that represents the condition that must be met in order for the request to proceed.
- options
- BlobRequestOptions
A BlobRequestOptions 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
A Task<TResult> object of type string that represents the asynchronous operation.
- Attributes
Applies to
DownloadTextAsync(Encoding, AccessCondition, BlobRequestOptions, OperationContext, CancellationToken)
Initiates an asynchronous operation to download the blob'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.Blob.BlobRequestOptions 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.Blob.BlobRequestOptions * 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.Blob.BlobRequestOptions * Microsoft.Azure.Storage.OperationContext * System.Threading.CancellationToken -> System.Threading.Tasks.Task<string>Public Overridable Function DownloadTextAsync (encoding As Encoding, accessCondition As AccessCondition, options As BlobRequestOptions, operationContext As OperationContext, cancellationToken As CancellationToken) As Task(Of String)Parameters
- encoding
- Encoding
An object that indicates the text encoding to use.
- accessCondition
- AccessCondition
An AccessCondition object that represents the condition that must be met in order for the request to proceed.
- options
- BlobRequestOptions
A BlobRequestOptions 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
A Task<TResult> object of type string that represents the asynchronous operation.
- Attributes
Applies to
DownloadTextAsync()
Initiates an asynchronous operation to download the blob'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
A Task<TResult> object of type string that represents the asynchronous operation.
- Attributes
Applies to
DownloadTextAsync(Encoding, AccessCondition, BlobRequestOptions, OperationContext)
Initiates an asynchronous operation to download the blob'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.Blob.BlobRequestOptions options, Microsoft.Azure.Storage.OperationContext operationContext);[<Microsoft.Azure.Storage.DoesServiceRequest>]
abstract member DownloadTextAsync : System.Text.Encoding * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.Blob.BlobRequestOptions * Microsoft.Azure.Storage.OperationContext -> System.Threading.Tasks.Task<string>
override this.DownloadTextAsync : System.Text.Encoding * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.Blob.BlobRequestOptions * Microsoft.Azure.Storage.OperationContext -> System.Threading.Tasks.Task<string>Public Overridable Function DownloadTextAsync (encoding As Encoding, accessCondition As AccessCondition, options As BlobRequestOptions, operationContext As OperationContext) As Task(Of String)Parameters
- encoding
- Encoding
An object that indicates the text encoding to use.
- accessCondition
- AccessCondition
An AccessCondition object that represents the condition that must be met in order for the request to proceed.
- options
- BlobRequestOptions
A BlobRequestOptions object that specifies additional options for the request.
- operationContext
- OperationContext
An OperationContext object that represents the context for the current operation.
Returns
A Task<TResult> object of type string that represents the asynchronous operation.
- Attributes
Applies to
Azure SDK for .NET