WebClient.DownloadStringAsync 方法

定义

命名空间:

System.Net

程序集:

System.Net.WebClient.dll

下载指定为 String 或 Uri的资源。 这些方法不会阻止调用线程。

重载

DownloadStringAsync(Uri)	下载指定为 Uri的资源。 此方法不会阻止调用线程。
DownloadStringAsync(Uri, Object)	将指定的字符串下载到指定的资源。 此方法不会阻止调用线程。

DownloadStringAsync(Uri)

Source:

WebClient.cs

下载指定为 Uri的资源。 此方法不会阻止调用线程。

public:
 void DownloadStringAsync(Uri ^ address);

public void DownloadStringAsync (Uri address);

member this.DownloadStringAsync : Uri -> unit

Public Sub DownloadStringAsync (address As Uri)

参数

address

Uri

包含要下载的 URI 的 Uri。

例外

ArgumentNullException

address 参数 null。

WebException

组合 BaseAddress 和 address 形成的 URI 无效。

-或-

下载资源时出错。

注解

谨慎

WebRequest、HttpWebRequest、ServicePoint和 WebClient 已过时，不应将其用于新开发。 请改用 HttpClient。

使用从线程池自动分配的线程资源异步下载资源。

下载资源后，此方法使用 Encoding 属性中指定的编码将资源转换为 String。 此方法不会在下载资源时阻止调用线程。 若要在等待服务器的响应时下载资源并阻止，请使用 DownloadString 方法。 下载完成后，将引发 DownloadStringCompleted 事件。 应用程序必须处理此事件才能接收通知。 下载的字符串在 Result 属性中可用。

在 .NET Framework 和 .NET Core 1.0 中，可以通过调用 CancelAsync 方法取消尚未完成的异步操作。

如果 BaseAddress 属性不是空字符串（“”）且 address 不包含绝对 URI，address 必须是与 BaseAddress 相结合的相对 URI，才能形成所请求数据的绝对 URI。 如果 QueryString 属性不是空字符串，则会将其追加到 address。

此方法使用 RETR 命令下载 FTP 资源。 对于 HTTP 资源，将使用 GET 方法。

注意

在应用程序中启用网络跟踪时，此成员将输出跟踪信息。 有关详细信息，请参阅 .NET Framework中的 网络跟踪。

此方法存储在任务中，它返回该方法的同步对应项可以引发的所有非使用异常。 如果异常存储在返回的任务中，则等待任务时将引发该异常。 使用异常（如 ArgumentException）仍同步引发。 有关存储的异常，请参阅 DownloadString(Uri)引发的异常。

DownloadStringAsync(Uri, Object)

Source:

WebClient.cs

将指定的字符串下载到指定的资源。 此方法不会阻止调用线程。

public:
 void DownloadStringAsync(Uri ^ address, System::Object ^ userToken);

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

member this.DownloadStringAsync : Uri * obj -> unit

Public Sub DownloadStringAsync (address As Uri, userToken As Object)

参数

address

Uri

包含要下载的 URI 的 Uri。

userToken

Object

在异步操作完成时传递给调用的方法的用户定义对象。

例外

ArgumentNullException

address 参数 null。

WebException

组合 BaseAddress 和 address 形成的 URI 无效。

-或-

下载资源时出错。

注解

谨慎

WebRequest、HttpWebRequest、ServicePoint和 WebClient 已过时，不应将其用于新开发。 请改用 HttpClient。

使用从线程池自动分配的线程资源异步下载资源。

下载资源后，此方法使用 Encoding 属性中指定的编码将资源转换为 String。 此方法不会在下载资源时阻止调用线程。 若要在等待服务器的响应时下载资源并阻止，请使用 DownloadString 方法。 下载完成后，将引发 DownloadStringCompleted 事件。 应用程序必须处理此事件才能接收通知。 下载的字符串在 Result 属性中可用。

在 .NET Framework 和 .NET Core 1.0 中，可以通过调用 CancelAsync 方法取消尚未完成的异步操作。

如果 BaseAddress 属性不是空字符串（“”）且 address 不包含绝对 URI，address 必须是与 BaseAddress 相结合的相对 URI，才能形成所请求数据的绝对 URI。 如果 QueryString 属性不是空字符串，则会将其追加到 address。

此方法使用 RETR 命令下载 FTP 资源。 对于 HTTP 资源，将使用 GET 方法。

注意

在应用程序中启用网络跟踪时，此成员将输出跟踪信息。 有关详细信息，请参阅 .NET Framework中的 网络跟踪。