WebClient.DownloadFileAsync Метод

Определение

Пространство имен:

System.Net

Сборка:

System.Net.WebClient.dll

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

Перегрузки

DownloadFileAsync(Uri, String)	Загружает в локальный файл ресурс с указанным универсальным кодом ресурса (URI). Этот метод не блокирует вызывающий поток.
DownloadFileAsync(Uri, String, Object)	Загружает в локальный файл ресурс с указанным универсальным кодом ресурса (URI). Этот метод не блокирует вызывающий поток.

DownloadFileAsync(Uri, String)

Исходный код:

WebClient.cs

Загружает в локальный файл ресурс с указанным универсальным кодом ресурса (URI). Этот метод не блокирует вызывающий поток.

public:
 void DownloadFileAsync(Uri ^ address, System::String ^ fileName);

public void DownloadFileAsync (Uri address, string fileName);

member this.DownloadFileAsync : Uri * string -> unit

Public Sub DownloadFileAsync (address As Uri, fileName As String)

Параметры

address

Uri

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

fileName

String

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

Исключения

ArgumentNullException

Параметр addressnull.

-или-

Параметр fileNamenull.

WebException

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

-или-

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

InvalidOperationException

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

Комментарии

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

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

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

Этот метод не блокирует вызывающий поток во время загрузки ресурса. Чтобы заблокировать время ожидания завершения скачивания, используйте один из методов DownloadFile.

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

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

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

Заметка

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

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

Этот метод сохраняет в задаче все исключения без использования, которые может вызывать синхронный аналог метода. Если исключение хранится в возвращаемой задаче, это исключение будет создано при ожидании задачи. Исключения использования, такие как ArgumentException, по-прежнему создаются синхронно. Сведения о сохраненных исключениях см. в исключениях, создаваемых DownloadFile(Uri, String).

DownloadFileAsync(Uri, String, Object)

Исходный код:

WebClient.cs

Загружает в локальный файл ресурс с указанным универсальным кодом ресурса (URI). Этот метод не блокирует вызывающий поток.

public:
 void DownloadFileAsync(Uri ^ address, System::String ^ fileName, System::Object ^ userToken);

public void DownloadFileAsync (Uri address, string fileName, object? userToken);

member this.DownloadFileAsync : Uri * string * obj -> unit

Public Sub DownloadFileAsync (address As Uri, fileName As String, userToken As Object)

Параметры

address

Uri

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

fileName

String

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

userToken

Object

Определяемый пользователем объект, который передается методу, вызываемого при завершении асинхронной операции.

Исключения

ArgumentNullException

Параметр addressnull.

-или-

Параметр fileNamenull.

WebException

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

-или-

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

InvalidOperationException

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

Комментарии

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

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

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

Этот метод не блокирует вызывающий поток во время загрузки ресурса. Чтобы заблокировать время ожидания завершения скачивания, используйте один из методов DownloadFile.

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

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

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

Заметка

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

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