Share via

CloudFile.DownloadToFile Method

  • Reference

Definition

Namespace:
Microsoft.Azure.Storage.File
Assembly:
Microsoft.Azure.Storage.File.dll
Package:
Microsoft.Azure.Storage.File v11.2.3

Downloads the contents of a file in the File service to a local file.

[Microsoft.Azure.Storage.DoesServiceRequest]
public virtual void DownloadToFile (string path, System.IO.FileMode mode, 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 DownloadToFile : string * System.IO.FileMode * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.File.FileRequestOptions * Microsoft.Azure.Storage.OperationContext -> unit
override this.DownloadToFile : string * System.IO.FileMode * Microsoft.Azure.Storage.AccessCondition * Microsoft.Azure.Storage.File.FileRequestOptions * Microsoft.Azure.Storage.OperationContext -> unit
Public Overridable Sub DownloadToFile (path As String, mode As FileMode, Optional accessCondition As AccessCondition = Nothing, Optional options As FileRequestOptions = Nothing, Optional operationContext As OperationContext = Nothing)

Parameters

path
String

The path to the target file in the local file system.

mode
FileMode

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

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.

Attributes
DoesServiceRequestAttribute

Applies to