This topic has not yet been rated - Rate this topic

DownloadDataCompletedEventArgs Class

Provides data for the DownloadDataCompleted event.

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

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 ();
}
// Sample call : DownLoadDataInBackground ("http://www.contoso.com/GameScores.html");
void DownloadDataInBackground (String* address)
{
    System::Threading::AutoResetEvent* waiter = new System::Threading::AutoResetEvent (false);
    WebClient* client = new WebClient ();

    // Specify that the DownloadDataCallback method gets called
    // when the download completes.
    client->DownloadDataCompleted += new DownloadDataCompletedEventHandler (DownloadDataCallback);
    client->DownloadDataAsync (address, 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 ();
    }
}
void DownloadDataCallback (Object* /*sender*/, DownloadDataCompletedEventArgs* e)
{
    System::Threading::AutoResetEvent* waiter = dynamic_cast<System::Threading::AutoResetEvent*>(e->UserToken);

    try
    {
        // If the request was not canceled and did not throw
        // an exception, display the resource.
        if (!e->Cancelled && e->Error == 0)
        {
            Byte data[] = dynamic_cast<Byte[]>(e->Result);
            String* textData = System::Text::Encoding::UTF8->GetString (data);

            Console::WriteLine (textData);
        }
    }
    __finally
    {
        // Let the main application thread resume.
        waiter->Set ();
    }
}
System.Object
  System.EventArgs
    System.ComponentModel.AsyncCompletedEventArgs
      System.Net.DownloadDataCompletedEventArgs
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

.NET Framework

Supported in: 3.5, 3.0, 2.0
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.