WebClient.DownloadFileTaskAsync Метод

Определение

Загружает указанный ресурс в локальный файл как асинхронная операция с помощью объекта задачи. Эти методы не блокируют вызывающий поток.

Перегрузки

DownloadFileTaskAsync(String, String)

Загружает указанный ресурс в локальный файл как асинхронная операция с помощью объекта задачи.

DownloadFileTaskAsync(Uri, String)

Загружает указанный ресурс в локальный файл как асинхронная операция с помощью объекта задачи.

DownloadFileTaskAsync(String, String)

Исходный код:
WebClient.cs
Исходный код:
WebClient.cs
Исходный код:
WebClient.cs

Загружает указанный ресурс в локальный файл как асинхронная операция с помощью объекта задачи.

public:
 System::Threading::Tasks::Task ^ DownloadFileTaskAsync(System::String ^ address, System::String ^ fileName);
public System.Threading.Tasks.Task DownloadFileTaskAsync (string address, string fileName);
[System.Runtime.InteropServices.ComVisible(false)]
public System.Threading.Tasks.Task DownloadFileTaskAsync (string address, string fileName);
member this.DownloadFileTaskAsync : string * string -> System.Threading.Tasks.Task
[<System.Runtime.InteropServices.ComVisible(false)>]
member this.DownloadFileTaskAsync : string * string -> System.Threading.Tasks.Task
Public Function DownloadFileTaskAsync (address As String, fileName As String) As Task

Параметры

address
String

URI загружаемого ресурса.

fileName
String

Имя файла, который должен быть размещен на локальном компьютере.

Возвращаемое значение

Объект задачи, представляющий асинхронную операцию.

Атрибуты

Исключения

Параметр address имеет значение null.

-или-

Параметр fileName имеет значение null.

URI, образованный объединением BaseAddress и address, является недопустимым.

-или-

Произошла ошибка при загрузке ресурса.

Локальный файл, определенный именем fileName, используется другим потоком.

Комментарии

Эта операция не блокируется. Возвращаемый Task объект завершится после загрузки ресурса данных.

Этот метод загружает ресурс по универсальному коду ресурса (URI), указанному в параметре address . После успешного завершения скачивания скачанный файл будет называться fileName на локальном компьютере. Файл загружается асинхронно с помощью ресурсов потока, которые автоматически выделяются из пула потоков.

В платформа .NET Framework и .NET Core 1.0 можно отменить асинхронные операции, которые не были завершены, вызвав CancelAsync метод .

BaseAddress Если свойство не является пустой строкой ("") и address не указывает абсолютный URI, то должен быть относительным URI, address который объединяется с BaseAddress для формирования абсолютного URI запрошенных данных. QueryString Если свойство не является пустой строкой, оно добавляется к address.

Этот метод использует команду RETR для скачивания ресурса FTP. Для ресурса HTTP используется метод GET.

Примечание

Данный член генерирует сведения трассировки, если в приложении включена трассировка сети. Дополнительные сведения см. в статье Трассировка сети в платформа .NET Framework.

При использовании этого метода на странице ASP.NET вы получите сообщение об ошибке, если учетная запись, в которую выполняется страница, не имеет разрешения на доступ к локальному файлу.

Применяется к

DownloadFileTaskAsync(Uri, String)

Исходный код:
WebClient.cs
Исходный код:
WebClient.cs
Исходный код:
WebClient.cs

Загружает указанный ресурс в локальный файл как асинхронная операция с помощью объекта задачи.

public:
 System::Threading::Tasks::Task ^ DownloadFileTaskAsync(Uri ^ address, System::String ^ fileName);
public System.Threading.Tasks.Task DownloadFileTaskAsync (Uri address, string fileName);
[System.Runtime.InteropServices.ComVisible(false)]
public System.Threading.Tasks.Task DownloadFileTaskAsync (Uri address, string fileName);
member this.DownloadFileTaskAsync : Uri * string -> System.Threading.Tasks.Task
[<System.Runtime.InteropServices.ComVisible(false)>]
member this.DownloadFileTaskAsync : Uri * string -> System.Threading.Tasks.Task
Public Function DownloadFileTaskAsync (address As Uri, fileName As String) As Task

Параметры

address
Uri

URI загружаемого ресурса.

fileName
String

Имя файла, который должен быть размещен на локальном компьютере.

Возвращаемое значение

Объект задачи, представляющий асинхронную операцию.

Атрибуты

Исключения

Параметр address имеет значение null.

-или-

Параметр fileName имеет значение null.

URI, образованный объединением BaseAddress и address, является недопустимым.

-или-

Произошла ошибка при загрузке ресурса.

Локальный файл, определенный именем fileName, используется другим потоком.

Комментарии

Эта операция не блокируется. Возвращаемый Task объект завершится после загрузки ресурса данных.

Этот метод загружает ресурс по универсальному коду ресурса (URI), указанному в параметре address . После успешного завершения скачивания скачанный файл будет называться fileName на локальном компьютере. Файл загружается асинхронно с помощью ресурсов потока, которые автоматически выделяются из пула потоков.

В платформа .NET Framework и .NET Core 1.0 можно отменить асинхронные операции, которые не были завершены, вызвав CancelAsync метод .

BaseAddress Если свойство не является пустой строкой ("") и address не указывает абсолютный URI, то должен быть относительным URI, address который объединяется с BaseAddress для формирования абсолютного URI запрошенных данных. QueryString Если свойство не является пустой строкой, оно добавляется к address.

Этот метод использует команду RETR для скачивания ресурса FTP. Для ресурса HTTP используется метод GET.

Примечание

Данный член генерирует сведения трассировки, если в приложении включена трассировка сети. Дополнительные сведения см. в статье Трассировка сети в платформа .NET Framework.

При использовании этого метода на странице ASP.NET вы получите сообщение об ошибке, если учетная запись, в которую выполняется страница, не имеет разрешения на доступ к локальному файлу.

Применяется к