WebClient.CancelAsync 方法

定義

命名空間:

System.Net

組件:

System.Net.WebClient.dll

來源:

WebClient.cs

取消暫止的異步操作。

public:
 void CancelAsync();

public void CancelAsync ();

member this.CancelAsync : unit -> unit

Public Sub CancelAsync ()

備註

謹慎

WebRequest、HttpWebRequest、ServicePoint和 WebClient 已經過時，您不應該將它們用於新的開發。 請改用 HttpClient。

如果作業擱置中，這個方法會在基礎 WebRequest上呼叫 Abort。

注意

從 .NET Core 2.0 開始，如果回應已開始擷取，CancelAsync 不會立即取消要求。 若要獲得最佳取消行為，請使用 HttpClient 類別，而不是 WebClient。

當您呼叫 CancelAsync時，您的應用程式仍然會收到與作業相關聯的完成事件。 例如，當您呼叫 CancelAsync 來取消 DownloadStringAsync 作業時，如果您已指定 DownloadStringCompleted 事件的事件處理程式，事件處理程式會收到作業已結束的通知。 若要了解作業是否順利完成，請檢查傳遞至事件處理程式之事件數據物件中 DownloadDataCompletedEventArgs 基類的 Cancelled 屬性。

如果沒有進行異步操作，這個方法就不會執行任何動作。