Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

DownloadDataCompletedEventArgs Class

Provides data for the DownloadDataCompleted event.

System.Object
  System.EventArgs
    System.ComponentModel.AsyncCompletedEventArgs
      System.Net.DownloadDataCompletedEventArgs

Namespace:  System.Net
Assembly:  System (in System.dll)
public class DownloadDataCompletedEventArgs : AsyncCompletedEventArgs

The DownloadDataCompletedEventArgs 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 data that is downloaded by a DownloadDataAsync 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 a hash function for a particular type. (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 DownloadDataCompletedEventHandler.

The following code example demonstrates downloading a user-specified resource.


    // Sample call : DownLoadDataInBackground ("http://www.contoso.com/GameScores.html");
    public static void DownloadDataInBackground (string address)
    {
        System.Threading.AutoResetEvent waiter = new System.Threading.AutoResetEvent (false);
        WebClient client = new WebClient ();
        Uri uri = new Uri(address);

        // Specify that the DownloadDataCallback method gets called
        // when the download completes.
        client.DownloadDataCompleted += new DownloadDataCompletedEventHandler (DownloadDataCallback);
        client.DownloadDataAsync (uri, waiter);

        // Block the main application thread. Real applications
        // can perform other tasks while waiting for the download to complete.
        waiter.WaitOne ();
    }



The following method is called when the download completes.


    private static void DownloadDataCallback (Object sender, DownloadDataCompletedEventArgs e)
    {
        System.Threading.AutoResetEvent waiter = (System.Threading.AutoResetEvent)e.UserState;

        try
        {
            // If the request was not canceled and did not throw
            // an exception, display the resource.
            if (!e.Cancelled && e.Error == null)
            {
                byte[] data = (byte[])e.Result;
                string textData = System.Text.Encoding.UTF8.GetString (data);

                Console.WriteLine (textData);
            }
        }
        finally
        {
            // Let the main application thread resume.
            waiter.Set ();
        }
    }



.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.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.