UploadFileCompletedEventArgs Class

Definition

Namespace:

System.Net

Assembly:

System.Net.WebClient.dll

Source:

WebClient.cs

Provides data for the UploadFileCompleted event.

public ref class UploadFileCompletedEventArgs : System::ComponentModel::AsyncCompletedEventArgs

public class UploadFileCompletedEventArgs : System.ComponentModel.AsyncCompletedEventArgs

type UploadFileCompletedEventArgs = class
    inherit AsyncCompletedEventArgs

Public Class UploadFileCompletedEventArgs
Inherits AsyncCompletedEventArgs

Inheritance

Object

EventArgs

AsyncCompletedEventArgs

UploadFileCompletedEventArgs

Examples

The following code example demonstrates asynchronously uploading a file.

// Sample call: UploadFileInBackground2("http://www.contoso.com/fileUpload.aspx", "data.txt")
void UploadFileInBackground2( String^ address, String^ fileName )
{
   WebClient^ client = gcnew WebClient;
   Uri ^uri = gcnew Uri(address);

   client->UploadFileCompleted +=
     gcnew UploadFileCompletedEventHandler (UploadFileCallback2);

   // Specify a progress notification handler.
   client->UploadProgressChanged +=
       gcnew UploadProgressChangedEventHandler( UploadProgressCallback );
   client->UploadFileAsync( uri, "POST", fileName );
   Console::WriteLine( "File upload started." );
}

// Sample call: UploadFileInBackground2("http://www.contoso.com/fileUpload.aspx", "data.txt")
public static void UploadFileInBackground2(string address, string fileName)
{
    WebClient client = new WebClient();
    Uri uri = new Uri(address);

    client.UploadFileCompleted += new UploadFileCompletedEventHandler(UploadFileCallback2);

    // Specify a progress notification handler.
    client.UploadProgressChanged += new UploadProgressChangedEventHandler(UploadProgressCallback);
    client.UploadFileAsync(uri, "POST", fileName);
    Console.WriteLine("File upload started.");
}

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

    Dim client As WebClient = New WebClient()
                Dim uri as Uri =  New Uri(address)
    AddHandler client.UploadFileCompleted, AddressOf UploadFileCallback2

    '  Specify a progress notification handler.
    AddHandler client.UploadProgressChanged, AddressOf UploadProgressCallback
    client.UploadFileAsync(uri, "POST", fileName)
    Console.WriteLine("File upload started.")
End Sub

The following method is called when the upload completes.

void UploadFileCallback2( Object^ /*sender*/, UploadFileCompletedEventArgs^ e )
{
   String^ reply = System::Text::Encoding::UTF8->GetString( e->Result );
   Console::WriteLine( reply );
}

private static void UploadFileCallback2(Object sender, UploadFileCompletedEventArgs e)
{
    string reply = System.Text.Encoding.UTF8.GetString(e.Result);
    Console.WriteLine(reply);
}

Private Shared Sub UploadFileCallback2(ByVal sender As Object, ByVal e As System.Net.UploadFileCompletedEventArgs)

    Dim reply As String = System.Text.Encoding.UTF8.GetString(e.Result)
    Console.WriteLine(reply)
End Sub

Remarks

Instances of this class are passed to the UploadFileCompletedEventHandler.

Properties

Cancelled	Gets a value indicating whether an asynchronous operation has been canceled. (Inherited from AsyncCompletedEventArgs)
Error	Gets a value indicating which error occurred during an asynchronous operation. (Inherited from AsyncCompletedEventArgs)
Result	Gets the server reply to a data upload operation that is started by calling an UploadFileAsync method.
UserState	Gets the unique identifier for the asynchronous task. (Inherited from AsyncCompletedEventArgs)

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
RaiseExceptionIfNecessary()	Raises a user-supplied exception if an asynchronous operation failed. (Inherited from AsyncCompletedEventArgs)
ToString()	Returns a string that represents the current object. (Inherited from Object)