CloudPageBlob.DownloadToFileAsync Method (String, FileMode, AccessCondition, BlobRequestOptions, OperationContext)

Article
05/14/2014

Initiates an asynchronous operation to download the contents of a page blob to a file.

Namespace: Microsoft.WindowsAzure.Storage.Blob
Assembly: Microsoft.WindowsAzure.Storage (in Microsoft.WindowsAzure.Storage.dll)

Syntax

'Declaration
<DoesServiceRequestAttribute> _
Public Function DownloadToFileAsync ( _
    path As String, _
    mode As FileMode, _
    accessCondition As AccessCondition, _
    options As BlobRequestOptions, _
    operationContext As OperationContext _
) As Task

[DoesServiceRequestAttribute] 
public Task DownloadToFileAsync (
    string path,
    FileMode mode,
    AccessCondition accessCondition,
    BlobRequestOptions options,
    OperationContext operationContext
)

[DoesServiceRequestAttribute] 
public:
virtual Task^ DownloadToFileAsync (
    String^ path, 
    FileMode mode, 
    AccessCondition^ accessCondition, 
    BlobRequestOptions^ options, 
    OperationContext^ operationContext
) sealed

Parameters

path
A string containing the path to the target file.

mode
A FileMode enumeration value that determines how to open or create the file.

accessCondition
An AccessCondition object that represents the condition that must be met in order for the request to proceed.

options
A BlobRequestOptions object that specifies additional options for the request.

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

Return Value

A Task object that represents the asynchronous operation.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Platforms

Development Platforms

Windows Vista, Windows 7 and Windows Server 2008