Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
UploadFileCompletedEventArgs Class
Collapse the table of content
Expand the table of content

UploadFileCompletedEventArgs Class

Provides data for the UploadFileCompleted event.

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

public class UploadFileCompletedEventArgs : AsyncCompletedEventArgs

The UploadFileCompletedEventArgs type exposes the following members.

  NameDescription
Public propertyCancelledGets a value indicating whether an asynchronous operation has been canceled. (Inherited from AsyncCompletedEventArgs.)
Public propertyErrorGets a value indicating which error occurred during an asynchronous operation. (Inherited from AsyncCompletedEventArgs.)
Public propertyResultGets the server reply to a data upload operation that is started by calling an UploadFileAsync method.
Public propertyUserStateGets the unique identifier for the asynchronous task. (Inherited from AsyncCompletedEventArgs.)
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Protected methodRaiseExceptionIfNecessaryRaises a user-supplied exception if an asynchronous operation failed. (Inherited from AsyncCompletedEventArgs.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

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

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

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

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