UploadFileCompletedEventHandler デリゲートとは何？わかりやすく解説 Weblio辞書

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

索引トップ用語の索引ランキング

UploadFileCompletedEventHandler デリゲート

メモ : このデリゲートは、.NET Framework version 2.0 で新しく追加されたものです。

WebClient の UploadFileCompleted イベントを処理するメソッドを表します。

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

Visual Basic (宣言)

Public Delegate Sub UploadFileCompletedEventHandler
 ( _
    sender As Object, _
    e As UploadFileCompletedEventArgs _
)

Visual Basic (使用法)

Dim instance As New UploadFileCompletedEventHandler(AddressOf
 HandlerMethod)

public delegate void UploadFileCompletedEventHandler
 (
    Object sender,
    UploadFileCompletedEventArgs e
)

C++

public delegate void UploadFileCompletedEventHandler
 (
    Object^ sender, 
    UploadFileCompletedEventArgs^ e
)

/** @delegate */
public delegate void UploadFileCompletedEventHandler
 (
    Object sender, 
    UploadFileCompletedEventArgs e
)

JScript

JScript では、デリゲートは使用できますが、新規に宣言することはできません。

パラメータ

sender: イベントのソース。

e: イベントデータを格納している UploadFileCompletedEventArgs。

解説

UploadFileCompletedEventHandler デリゲートを作成する場合は、イベントを処理するメソッドを識別してください。イベントをイベントハンドラに関連付けるには、デリゲートのインスタンスをイベントに追加します。デリゲートを削除しない限り、そのイベントが発生すると常にイベントハンドラが呼び出されます。イベントハンドラデリゲートの詳細については、「イベントとデリゲート」を参照してください。

使用例

非同期的にファイルをアップロードするコード例を次に示します。

Visual Basic

'  Sample call: UploadFileInBackground("http:' www.contoso.com/fileUpload.aspx",
 "data.txt")
Public Shared Sub UploadFileInBackground(ByVal
 address As String, ByVal
 fileName As String)

    Dim waiter As System.Threading.AutoResetEvent
 = New System.Threading.AutoResetEvent(False)
    Dim client As WebClient = New
 WebClient()
    Dim method As String
 = "POST"
                 Dim uri as Uri =  New
 Uri(address)

    '  Specify that that UploadFileCallback method gets called
    '  when the file upload completes.
    AddHandler client.UploadFileCompleted, AddressOf
 UploadFileCallback
    client.UploadFileAsync(uri, method, fileName, waiter)

    '  Block the main application thread. Real applications
    '  can perform other tasks while waiting for the upload to complete.
    waiter.WaitOne()
    Console.WriteLine("File upload is complete.")
End Sub

// Sample call: UploadFileInBackground("http://www.contoso.com/fileUpload.aspx",
 "data.txt")
public static void UploadFileInBackground
 (string address, string fileName)
{
    System.Threading.AutoResetEvent waiter = new System.Threading.AutoResetEvent
 (false);
    WebClient client = new WebClient ();
    Uri uri = new Uri(address);
    string method = "POST";

    // Specify that that UploadFileCallback method gets called
    // when the file upload completes.
    client.UploadFileCompleted += new UploadFileCompletedEventHandler
 (UploadFileCallback);
    client.UploadFileAsync (uri, method, fileName, waiter);

    // Block the main application thread. Real applications
    // can perform other tasks while waiting for the upload to complete.
    waiter.WaitOne ();
    Console.WriteLine ("File upload is complete.");
}

アップロードが完了すると次のメソッドが呼び出されます。

Visual Basic

Public Shared Sub UploadFileCallback(ByVal
 sender As Object, ByVal
 e As System.Net.UploadFileCompletedEventArgs)

    Dim waiter As System.Threading.AutoResetEvent
 = CType(e.UserState, System.Threading.AutoResetEvent)
    Try

        Dim reply As String
 = System.Text.Encoding.UTF8.GetString(e.Result)
        Console.WriteLine(reply)
    Finally
        '  If this thread throws an exception, make sure that
        '  you let the main application thread resume.
        waiter.Set()
    End Try
End Sub

public static void UploadFileCallback
 (Object sender, UploadFileCompletedEventArgs e)
{
    System.Threading.AutoResetEvent waiter = (System.Threading.AutoResetEvent)e.UserState;;
    try
    {
        string reply = System.Text.Encoding.UTF8.GetString (e.Result);

        Console.WriteLine (reply);
    }
    finally
    {
        // If this thread throws an exception, make sure that
        // you let the main application thread resume.
        waiter.Set ();
    }
}