WebClient.OpenReadAsync 方法

定义

命名空间:

System.Net

程序集:

System.Net.WebClient.dll

打开包含指定资源的可读流。 这些方法不会阻止调用线程。

重载

OpenReadAsync(Uri)	打开包含指定资源的可读流。 此方法不会阻止调用线程。
OpenReadAsync(Uri, Object)	打开包含指定资源的可读流。 此方法不会阻止调用线程。

OpenReadAsync(Uri)

Source:

WebClient.cs

打开包含指定资源的可读流。 此方法不会阻止调用线程。

public:
 void OpenReadAsync(Uri ^ address);

public void OpenReadAsync (Uri address);

member this.OpenReadAsync : Uri -> unit

Public Sub OpenReadAsync (address As Uri)

参数

address

Uri

要检索的资源的 URI。

例外

ArgumentNullException

address 参数 null。

WebException

组合 BaseAddress 和地址构成的 URI 无效。

-或-

下载资源时出错。

-或-

打开流时出错。

注解

谨慎

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

此方法检索用于访问 address 参数指定的资源的 Stream 实例。 该流是使用从线程池自动分配的线程资源获取的。 若要在流可用时接收通知，请将事件处理程序添加到 OpenReadCompleted 事件。

注意

完成 Stream 后，必须调用 Stream.Close，以避免系统资源耗尽。

此方法不会在流打开时阻止调用线程。 若要在等待流时阻止，请使用 OpenReadAsync 方法。

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

如果 BaseAddress 属性不是空字符串（“”）且 address 未指定绝对 URI，address 必须是与 BaseAddress 相结合的相对 URI，才能形成所请求资源的绝对 URI。 如果未 nullQueryString 属性，则会将其追加到 address。

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

注意

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

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

OpenReadAsync(Uri, Object)

Source:

WebClient.cs

打开包含指定资源的可读流。 此方法不会阻止调用线程。

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

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

member this.OpenReadAsync : Uri * obj -> unit

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

参数

address

Uri

要检索的资源的 URI。

userToken

Object

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

例外

ArgumentNullException

address 参数 null。

WebException

组合 BaseAddress 和地址构成的 URI 无效。

-或-

下载资源时出错。

-或-

打开流时出错。

注解

谨慎

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

此方法检索用于访问 address 参数指定的资源的 Stream 实例。 该流是使用从线程池自动分配的线程资源获取的。 若要在流可用时接收通知，请将事件处理程序添加到 OpenReadCompleted 事件。

注意

完成 Stream 后，必须调用 Stream.Close，以避免系统资源耗尽。

此方法不会在流打开时阻止调用线程。 若要在等待流时阻止，请使用 OpenRead 方法。

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

如果 BaseAddress 属性不是空字符串（“”）且 address 未指定绝对 URI，address 必须是与 BaseAddress 相结合的相对 URI，才能形成所请求资源的绝对 URI。 如果未 nullQueryString 属性，则会将其追加到 address。

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

注意

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