This documentation is archived and is not being maintained.

UploadFileCompletedEventHandler Delegate

Represents the method that will handle the UploadFileCompleted event of a WebClient.

Namespace:  System.Net
Assembly:  System (in System.dll)

JScript does not support delegates.

Parameters

sender
Type: System.Object

The source of the event.

e
Type: System.Net.UploadFileCompletedEventArgs

A UploadFileCompletedEventArgs that contains event data.

When you create a UploadFileCompletedEventHandler delegate, you identify the method that will handle the event. To associate the event with your event handler, add an instance of the delegate to the event. The event handler is called whenever the event occurs, unless you remove the delegate. For more information about event handler delegates, see Events and Delegates.

The following code example demonstrates asynchronously uploading a file.

No code example is currently available or this language may not be supported.
// Sample call: UploadFileInBackground("http://www.contoso.com/fileUpload.aspx", "data.txt")
void UploadFileInBackground (String* address, String* fileName)
{
    System::Threading::AutoResetEvent* waiter = new System::Threading::AutoResetEvent (false);
    WebClient* client = new WebClient ();
    String* method = S"POST";

    // Specify that that UploadFileCallback method gets called
    // when the file upload completes.
    client->UploadFileCompleted += new UploadFileCompletedEventHandler (UploadFileCallback);
    client->UploadFileAsync (address, 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 (S"File upload is complete.");
}

The following method is called when the upload completes.

No code example is currently available or this language may not be supported.
void UploadFileCallback (Object* /*sender*/, UploadFileCompletedEventArgs* e)
{
    System::Threading::AutoResetEvent* waiter = dynamic_cast<System::Threading::AutoResetEvent*>(e->UserToken);;
    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 ();
    }
}

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

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0
Show: