CloudFile.DownloadText Method

Definition

Namespace:

Microsoft.Azure.Storage.File

Assembly:

Microsoft.Azure.Storage.File.dll

Package:

Microsoft.Azure.Storage.File v11.2.3

Downloads the file's contents as a string.

[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual string DownloadText (System.Text.Encoding encoding = default, 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 DownloadText : System.Text.Encoding * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.File.FileRequestOptions * Microsoft.Azure.Storage.OperationContext -> string
override this.DownloadText : System.Text.Encoding * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.File.FileRequestOptions * Microsoft.Azure.Storage.OperationContext -> string

Public Overridable Function DownloadText (Optional encoding As Encoding = Nothing, Optional accessCondition As AccessCondition = Nothing, Optional options As FileRequestOptions = Nothing, Optional operationContext As OperationContext = Nothing) As 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

A FileRequestOptions object that specifies additional options for the request.

operationContext

OperationContext

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

Returns

String

The contents of the file, as a string.

Attributes

DoesServiceRequestAttribute