WebClient.CancelAsync メソッド

.NET Framework クラス ライブラリ リファレンス

WebClient.CancelAsync メソッド

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

保留中の非同期操作をキャンセルします。

名前空間: System.Net
アセンブリ: System (system.dll 内)
構文

Visual Basic (宣言)

Public Sub CancelAsync

Visual Basic (使用法)

Dim instance As WebClient

instance.CancelAsync

C#

public void CancelAsync ()

C++

public:
void CancelAsync ()

J#

public void CancelAsync ()

JScript

public function CancelAsync ()

解説

操作が保留中の場合、このメソッドは基になる WebRequest に対して Abort を呼び出します。

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

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

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Millennium Edition, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0

参照

関連項目
WebClient クラス
WebClient メンバ
System.Net 名前空間