Export (0) Print
Expand All

UploadFileCompletedEventArgs Class

Provides data for the UploadFileCompleted event.

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

'Declaration
Public Class UploadFileCompletedEventArgs _
	Inherits 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 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.

        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

.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

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.

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:
© 2014 Microsoft