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

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

fileName

String

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

Исключения

ArgumentNullException

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

-или-

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

WebException

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

-или-

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

InvalidOperationException

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

Комментарии

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

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

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

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

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

fileName

String

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

userToken

Object

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

Исключения

ArgumentNullException

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

-или-

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

WebException

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

-или-

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

InvalidOperationException

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

Комментарии

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

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

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

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

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

Примечание

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

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