Export (0) Print
Expand All
Expand Minimize

UploadFileCompletedEventHandler Delegate

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

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

public delegate void UploadFileCompletedEventHandler(
	Object sender,
	UploadFileCompletedEventArgs e
)

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.

    // 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.");
    }

The following method is called when the upload completes.

    private 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 ();
        }
    }

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Show:
© 2014 Microsoft