UploadFileCompletedEventArgs Class

 

Provides data for the UploadFileCompleted event.

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

System.Object
  System.EventArgs
    System.ComponentModel.AsyncCompletedEventArgs
      System.Net.UploadFileCompletedEventArgs

public class UploadFileCompletedEventArgs : AsyncCompletedEventArgs

NameDescription
System_CAPS_pubpropertyCancelled

Gets a value indicating whether an asynchronous operation has been canceled.(Inherited from AsyncCompletedEventArgs.)

System_CAPS_pubpropertyError

Gets a value indicating which error occurred during an asynchronous operation.(Inherited from AsyncCompletedEventArgs.)

System_CAPS_pubpropertyResult

Gets the server reply to a data upload operation that is started by calling an UploadFileAsync method.

System_CAPS_pubpropertyUserState

Gets the unique identifier for the asynchronous task.(Inherited from AsyncCompletedEventArgs.)

NameDescription
System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_protmethodRaiseExceptionIfNecessary()

Raises a user-supplied exception if an asynchronous operation failed.(Inherited from AsyncCompletedEventArgs.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

Instances of this class are passed to the UploadFileCompletedEventHandler.

The following code example demonstrates asynchronously uploading a file.

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

The following method is called when the upload completes.

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

.NET Framework
Available since 2.0

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: