WebClient.DownloadFileCompleted イベント

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

WebClient.DownloadFileCompleted イベント

メモ : このイベントは、.NET Framework version 2.0 で新しく追加されたものです。

非同期のファイル ダウンロード操作の完了時に発生します。

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

Visual Basic (宣言)

Public Event DownloadFileCompleted As
 AsyncCompletedEventHandler

Visual Basic (使用法)

Dim instance As WebClient
Dim handler As AsyncCompletedEventHandler

AddHandler instance.DownloadFileCompleted, handler

C#

public event AsyncCompletedEventHandler DownloadFileCompleted

C++

public:
event AsyncCompletedEventHandler^ DownloadFileCompleted {
    void add (AsyncCompletedEventHandler^ value);
    void remove (AsyncCompletedEventHandler^ value);
}

J#

/** @event */
public void add_DownloadFileCompleted (AsyncCompletedEventHandler
 value)

/** @event */
public void remove_DownloadFileCompleted (AsyncCompletedEventHandler
 value)

JScript

JScript では、イベントは使用できますが、新規に宣言することはできません。

解説

このイベントは、非同期のファイル ダウンロード操作が完了するたびに発生します。非同期のファイル ダウンロードは、DownloadFileAsync メソッドを呼び出すことによって開始されます。

AsyncCompletedEventHandler は、このイベントのデリゲートです。AsyncCompletedEventArgs クラスは、イベント ハンドラにイベント データを提供します。

イベント処理の詳細については、「イベントの利用」を参照してください。

使用例

このイベントのイベント ハンドラを設定するコード例を次に示します。

Visual Basic

'  Sample call : DownLoadFileInBackground2 ("http:' www.contoso.com/logs/January.txt")
Public Shared Sub DownLoadFileInBackground2(ByVal
 address As String)

    Dim client As WebClient = New
 WebClient()

    '  Specify that the DownloadFileCallback method gets called
    '  when the download completes.
    AddHandler client.DownloadFileCompleted, AddressOf
 DownloadFileCallback2
    '  Specify a progress notification handler.
    AddHandler client.DownloadProgressChanged, AddressOf
 DownloadProgressCallback
                Dim uri as Uri = New
 Uri(address)
    client.DownloadFileAsync(uri, "serverdata.txt")
End Sub

C#

// Sample call : DownLoadFileInBackground2 ("http://www.contoso.com/logs/January.txt");
public static void DownLoadFileInBackground2
 (string address)
{
    WebClient client = new WebClient ();
    Uri uri = new Uri(address);

    // Specify that the DownloadFileCallback method gets called
    // when the download completes.
    client.DownloadFileCompleted += new AsyncCompletedEventHandler
 (DownloadFileCallback2);
    // Specify a progress notification handler.
    client.DownloadProgressChanged += new DownloadProgressChangedEventHandler(DownloadProgressCallback);
    client.DownloadFileAsync (uri, "serverdata.txt");
}

プラットフォーム

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 名前空間