This topic has not yet been rated - Rate this topic

DownloadStringCompletedEventArgs Class

Provides data for the DownloadStringCompleted event.

System.Object
  System.EventArgs
    System.ComponentModel.AsyncCompletedEventArgs
      System.Net.DownloadStringCompletedEventArgs

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

The DownloadStringCompletedEventArgs type exposes the following members.

  Name Description
Public property Supported by Portable Class Library Cancelled Gets a value indicating whether an asynchronous operation has been canceled. (Inherited from AsyncCompletedEventArgs.)
Public property Supported by Portable Class Library Error Gets a value indicating which error occurred during an asynchronous operation. (Inherited from AsyncCompletedEventArgs.)
Public property Supported by Portable Class Library Result Gets the data that is downloaded by a DownloadStringAsync method.
Public property Supported by Portable Class Library UserState Gets the unique identifier for the asynchronous task. (Inherited from AsyncCompletedEventArgs.)
Top
  Name Description
Public method Supported by Portable Class Library Equals(Object) Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Supported by Portable Class Library Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method Supported by Portable Class Library GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method Supported by Portable Class Library GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method Supported by Portable Class Library MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Protected method Supported by Portable Class Library RaiseExceptionIfNecessary Raises a user-supplied exception if an asynchronous operation failed. (Inherited from AsyncCompletedEventArgs.)
Public method Supported by Portable Class Library ToString Returns a string that represents the current object. (Inherited from Object.)
Top

Instances of this class are passed to the DownloadStringCompletedEventHandler.

The following code example demonstrates downloading a string asynchronously.


    // Sample call : DownloadStringInBackground2 ("http://www.contoso.com/GameScores.html");
    public static void DownloadStringInBackground2 (string address)
    {
        WebClient client = new WebClient ();
        Uri uri = new Uri(address);

        // Specify that the DownloadStringCallback2 method gets called
        // when the download completes.
        client.DownloadStringCompleted += new DownloadStringCompletedEventHandler (DownloadStringCallback2);
        client.DownloadStringAsync (uri);
    }



The following method is called when the download completes.


    private static void DownloadStringCallback2 (Object sender, DownloadStringCompletedEventArgs e)
    {
        // If the request was not canceled and did not throw
        // an exception, display the resource.
        if (!e.Cancelled && e.Error == null)
        {
            string textString = (string)e.Result;

            Console.WriteLine (textString);
        }
    }



.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

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.
Did you find this helpful?
(1500 characters remaining)
Community Content Add
Annotations FAQ