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)

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


Type: System::Object
The source of the event.
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("", "data.txt")
void UploadFileInBackground( String^ address, String^ fileName )
   System::Threading::AutoResetEvent^ waiter = gcnew System::Threading::AutoResetEvent( false );
   WebClient^ client = gcnew WebClient;
   Uri ^uri = gcnew Uri(address);
   String^ method = "POST";

   // Specify that that UploadFileCallback method gets called
   // when the file upload completes.
   client->UploadFileCompleted += gcnew 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.
   Console::WriteLine( "File upload is complete." );

The following method is called when the upload completes.

void UploadFileCallback( Object^ /*sender*/, UploadFileCompletedEventArgs^ e )
   System::Threading::AutoResetEvent^ waiter = dynamic_cast<System::Threading::AutoResetEvent^>(e->UserState);
      String^ reply = System::Text::Encoding::UTF8->GetString( e->Result );
      Console::WriteLine( reply );

      // If this thread throws an exception, make sure that
      // you let the main application thread resume.


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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