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 は要求をすぐに取り消しません。 キャンセル動作を最適にするには、WebClientの代わりに HttpClient クラスを使用します。

CancelAsyncを呼び出しても、アプリケーションは操作に関連付けられている完了イベントを受け取ります。 たとえば、CancelAsync を呼び出して DownloadStringAsync 操作を取り消すときに、DownloadStringCompleted イベントのイベント ハンドラーを指定した場合、イベント ハンドラーは操作が終了したことを示す通知を受け取ります。 操作が正常に完了したかどうかを確認するには、イベント ハンドラーに渡されたイベント データ オブジェクトの DownloadDataCompletedEventArgs の基底クラスの Cancelled プロパティを確認します。

非同期操作が進行中でない場合、このメソッドは何も行いません。