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

Универсальный код ресурса для скачивания.

fileName
String

Имя файла, который нужно поместить на локальный компьютер.

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

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

Атрибуты

Исключения

Параметр addressnull.

-или-

Параметр fileNamenull.

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

-или-

Произошла ошибка при скачивании ресурса.

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

Комментарии

Осторожность

WebRequest, HttpWebRequest, ServicePointи WebClient устарели, и их не следует использовать для новой разработки. Вместо этого используйте HttpClient.

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

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

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

Если свойство BaseAddress не является пустой строкой ("") и address не указывает абсолютный URI, address должен быть относительным URI, объединенным с 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

Универсальный код ресурса для скачивания.

fileName
String

Имя файла, который нужно поместить на локальный компьютер.

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

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

Атрибуты

Исключения

Параметр addressnull.

-или-

Параметр fileNamenull.

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

-или-

Произошла ошибка при скачивании ресурса.

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

Комментарии

Осторожность

WebRequest, HttpWebRequest, ServicePointи WebClient устарели, и их не следует использовать для новой разработки. Вместо этого используйте HttpClient.

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

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

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

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

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

Заметка

Этот элемент выводит сведения о трассировке при включении трассировки сети в приложении. Дополнительные сведения см. в разделе Трассировка сети в.NET Framework.

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

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