CloudFile.BeginDownloadText Method (Encoding, AccessCondition, FileRequestOptions, OperationContext, AsyncCallback, Object) (Microsoft.WindowsAzure.Storage.File)
From Microsoft Windows Azure Storage Blob
C#
C++
F#
VB
CloudFile.::..BeginDownloadText Method (Encoding, AccessCondition, FileRequestOptions, OperationContext, AsyncCallback, Object)(Encoding^, AccessCondition^, FileRequestOptions^, OperationContext^, AsyncCallback^, Object^)(Encoding, AccessCondition, FileRequestOptions, OperationContext, AsyncCallback, Object)(Encoding, AccessCondition, FileRequestOptions, OperationContext, AsyncCallback, Object)
Begins an asynchronous operation to download the file's contents as a string.
Namespace:
Microsoft.WindowsAzure.Storage.File
Assembly:
Microsoft.WindowsAzure.Storage (in Microsoft.WindowsAzure.Storage.dll)
Syntax
[DoesServiceRequestAttribute]
public virtual ICancellableAsyncResult BeginDownloadText(
Encoding encoding,
AccessCondition accessCondition,
FileRequestOptions options,
OperationContext operationContext,
AsyncCallback callback,
object state
)
C++
public:
[DoesServiceRequestAttribute]
virtual ICancellableAsyncResult^ BeginDownloadText(
Encoding^ encoding,
AccessCondition^ accessCondition,
FileRequestOptions^ options,
OperationContext^ operationContext,
AsyncCallback^ callback,
Object^ state
)
[<DoesServiceRequestAttribute>]
abstract BeginDownloadText :
encoding:Encoding *
accessCondition:AccessCondition *
options:FileRequestOptions *
operationContext:OperationContext *
callback:AsyncCallback *
state:Object -> ICancellableAsyncResult
[<DoesServiceRequestAttribute>]
override BeginDownloadText :
encoding:Encoding *
accessCondition:AccessCondition *
options:FileRequestOptions *
operationContext:OperationContext *
callback:AsyncCallback *
state:Object -> ICancellableAsyncResult
<DoesServiceRequestAttribute>
Public Overridable Function BeginDownloadText (
encoding As Encoding,
accessCondition As AccessCondition,
options As FileRequestOptions,
operationContext As OperationContext,
callback As AsyncCallback,
state As Object
) As ICancellableAsyncResult
Parameters
- encoding
-
Type:
System.Text.EncodingSystem.Text::Encoding^System.Text.EncodingSystem.Text.Encoding
A Encoding object that indicates the type of text encoding to use.
- accessCondition
-
Type:
Microsoft.WindowsAzure.Storage.AccessConditionMicrosoft.WindowsAzure.Storage::AccessCondition^Microsoft.WindowsAzure.Storage.AccessConditionMicrosoft.WindowsAzure.Storage.AccessCondition
An AccessCondition object that represents the access conditions for the file.
- options
-
Type:
Microsoft.WindowsAzure.Storage.File.FileRequestOptionsMicrosoft.WindowsAzure.Storage.File::FileRequestOptions^Microsoft.WindowsAzure.Storage.File.FileRequestOptionsMicrosoft.WindowsAzure.Storage.File.FileRequestOptions
A FileRequestOptions object that specifies additional options for the request.
- operationContext
-
Type:
Microsoft.WindowsAzure.Storage.OperationContextMicrosoft.WindowsAzure.Storage::OperationContext^Microsoft.WindowsAzure.Storage.OperationContextMicrosoft.WindowsAzure.Storage.OperationContext
An OperationContext object that represents the context for the current operation.
- callback
-
Type:
System.AsyncCallbackSystem::AsyncCallback^System.AsyncCallbackSystem.AsyncCallback
The callback delegate that will receive notification when the asynchronous operation completes.
- state
-
Type:
System.ObjectSystem::Object^System.ObjectSystem.Object
A user-defined object that will be passed to the callback delegate.
Return Value
Type:
Microsoft.WindowsAzure.Storage.ICancellableAsyncResultMicrosoft.WindowsAzure.Storage::ICancellableAsyncResult^Microsoft.WindowsAzure.Storage.ICancellableAsyncResultMicrosoft.WindowsAzure.Storage.ICancellableAsyncResultAn ICancellableAsyncResult that references the asynchronous operation.
Return to top
Begins an asynchronous operation to download the file's contents as a string.
Syntax
[DoesServiceRequestAttribute] public virtual ICancellableAsyncResult BeginDownloadText( Encoding encoding, AccessCondition accessCondition, FileRequestOptions options, OperationContext operationContext, AsyncCallback callback, object state )
C++
public: [DoesServiceRequestAttribute] virtual ICancellableAsyncResult^ BeginDownloadText( Encoding^ encoding, AccessCondition^ accessCondition, FileRequestOptions^ options, OperationContext^ operationContext, AsyncCallback^ callback, Object^ state )
[<DoesServiceRequestAttribute>] abstract BeginDownloadText : encoding:Encoding * accessCondition:AccessCondition * options:FileRequestOptions * operationContext:OperationContext * callback:AsyncCallback * state:Object -> ICancellableAsyncResult [<DoesServiceRequestAttribute>] override BeginDownloadText : encoding:Encoding * accessCondition:AccessCondition * options:FileRequestOptions * operationContext:OperationContext * callback:AsyncCallback * state:Object -> ICancellableAsyncResult
<DoesServiceRequestAttribute> Public Overridable Function BeginDownloadText ( encoding As Encoding, accessCondition As AccessCondition, options As FileRequestOptions, operationContext As OperationContext, callback As AsyncCallback, state As Object ) As ICancellableAsyncResult
Parameters
- encoding
-
Type:
System.Text.EncodingSystem.Text::Encoding^System.Text.EncodingSystem.Text.Encoding
A Encoding object that indicates the type of text encoding to use.
- accessCondition
-
Type:
Microsoft.WindowsAzure.Storage.AccessConditionMicrosoft.WindowsAzure.Storage::AccessCondition^Microsoft.WindowsAzure.Storage.AccessConditionMicrosoft.WindowsAzure.Storage.AccessCondition
An AccessCondition object that represents the access conditions for the file.
- options
-
Type:
Microsoft.WindowsAzure.Storage.File.FileRequestOptionsMicrosoft.WindowsAzure.Storage.File::FileRequestOptions^Microsoft.WindowsAzure.Storage.File.FileRequestOptionsMicrosoft.WindowsAzure.Storage.File.FileRequestOptions
A FileRequestOptions object that specifies additional options for the request.
- operationContext
-
Type:
Microsoft.WindowsAzure.Storage.OperationContextMicrosoft.WindowsAzure.Storage::OperationContext^Microsoft.WindowsAzure.Storage.OperationContextMicrosoft.WindowsAzure.Storage.OperationContext
An OperationContext object that represents the context for the current operation.
- callback
-
Type:
System.AsyncCallbackSystem::AsyncCallback^System.AsyncCallbackSystem.AsyncCallback
The callback delegate that will receive notification when the asynchronous operation completes.
- state
-
Type:
System.ObjectSystem::Object^System.ObjectSystem.Object
A user-defined object that will be passed to the callback delegate.
Return Value
Type: Microsoft.WindowsAzure.Storage.ICancellableAsyncResultMicrosoft.WindowsAzure.Storage::ICancellableAsyncResult^Microsoft.WindowsAzure.Storage.ICancellableAsyncResultMicrosoft.WindowsAzure.Storage.ICancellableAsyncResultAn ICancellableAsyncResult that references the asynchronous operation.