DownloadStringCompletedEventArgs Class
.NET Framework 4.5
Provides data for the DownloadStringCompleted event.
System.Object
System.EventArgs
System.ComponentModel.AsyncCompletedEventArgs
System.Net.DownloadStringCompletedEventArgs
System.EventArgs
System.ComponentModel.AsyncCompletedEventArgs
System.Net.DownloadStringCompletedEventArgs
Namespace: System.Net
Assembly: System (in System.dll)
The DownloadStringCompletedEventArgs type exposes the following members.
| Name | Description | |
|---|---|---|
 | Cancelled | Gets a value indicating whether an asynchronous operation has been canceled. (Inherited from AsyncCompletedEventArgs.) |
| Error | Gets a value indicating which error occurred during an asynchronous operation. (Inherited from AsyncCompletedEventArgs.) |
| Result | Gets the data that is downloaded by a DownloadStringAsync method. |
| UserState | Gets the unique identifier for the asynchronous task. (Inherited from AsyncCompletedEventArgs.) |
| Name | Description | |
|---|---|---|
| Equals(Object) | Determines whether the specified object is equal to the current object. (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| RaiseExceptionIfNecessary | Raises a user-supplied exception if an asynchronous operation failed. (Inherited from AsyncCompletedEventArgs.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
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);
}
}
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.
