WebClient.DownloadStringAsync Метод

Определение

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

Перегрузки

DownloadStringAsync(Uri)

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

DownloadStringAsync(Uri, Object)

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

DownloadStringAsync(Uri)

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

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

public void DownloadStringAsync (Uri address);

Параметры

address
Uri

Uri, содержащий URI для скачивания.

Исключения

Параметр addressnull.

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

-или-

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

Комментарии

Внимание!

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

Ресурс загружается асинхронно с помощью ресурсов потоков, которые автоматически выделяются из пула потоков.

После скачивания ресурса этот метод использует кодировку, указанную в свойстве Encoding, для преобразования ресурса в String. Этот метод не блокирует вызывающий поток при скачивании ресурса. Чтобы скачать ресурс и заблокировать при ожидании ответа сервера, используйте метод DownloadString. По завершении скачивания вызывается событие DownloadStringCompleted. Приложение должно обрабатывать это событие для получения уведомлений. Скачанная строка доступна в свойстве Result.

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

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

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

Примечание

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

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

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

.NET 9 и другие версии
Продукт Версии
.NET Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 2.0, 2.1

DownloadStringAsync(Uri, Object)

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

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

public void DownloadStringAsync (Uri address, object? userToken);
public void DownloadStringAsync (Uri address, object userToken);

Параметры

address
Uri

Uri, содержащий URI для скачивания.

userToken
Object

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

Исключения

Параметр addressnull.

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

-или-

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

Комментарии

Внимание!

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

Ресурс загружается асинхронно с помощью ресурсов потоков, которые автоматически выделяются из пула потоков.

После скачивания ресурса этот метод использует кодировку, указанную в свойстве Encoding, для преобразования ресурса в String. Этот метод не блокирует вызывающий поток при скачивании ресурса. Чтобы скачать ресурс и заблокировать при ожидании ответа сервера, используйте метод DownloadString. По завершении скачивания вызывается событие DownloadStringCompleted. Приложение должно обрабатывать это событие для получения уведомлений. Скачанная строка доступна в свойстве Result.

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

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

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

Примечание

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

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

.NET 9 и другие версии
Продукт Версии
.NET Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 2.0, 2.1