WebClient.OpenReadAsync 方法

定義

命名空間:

System.Net

組件:

System.Net.WebClient.dll

開啟包含指定資源的可讀取數據流。 這些方法不會封鎖呼叫線程。

多載

OpenReadAsync(Uri)	開啟包含指定資源的可讀取數據流。 這個方法不會封鎖呼叫線程。
OpenReadAsync(Uri, Object)	開啟包含指定資源的可讀取數據流。 這個方法不會封鎖呼叫線程。

OpenReadAsync(Uri)

來源:

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。 如果 QueryString 屬性不是 null，則會附加至 address。

此方法會使用 RETR 命令來下載 FTP 資源。 針對 HTTP 資源，會使用 GET 方法。

注意

當您在應用程式中啟用網路追蹤時，此成員會輸出追蹤資訊。 如需詳細資訊，請參閱 .NET Framework 中的網路追蹤。

這個方法會儲存在工作中，它會傳回方法同步對應項可以擲回的所有非使用例外狀況。 如果例外狀況儲存在傳回的工作中，則會在等候工作時擲回該例外狀況。 使用例外狀況，例如 ArgumentException，仍會同步擲回。 如需預存的例外狀況，請參閱 OpenRead(Uri)擲回的例外狀況。

OpenReadAsync(Uri, Object)

來源:

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。 如果 QueryString 屬性不是 null，則會附加至 address。

此方法會使用 RETR 命令來下載 FTP 資源。 針對 HTTP 資源，會使用 GET 方法。

注意

當您在應用程式中啟用網路追蹤時，此成員會輸出追蹤資訊。 如需詳細資訊，請參閱 .NET Framework 中的網路追蹤。