This documentation is archived and is not being maintained.

DownloadStringCompletedEventArgs Class

Provides data for the DownloadStringCompleted event.

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

'Declaration
Public Class DownloadStringCompletedEventArgs _
	Inherits AsyncCompletedEventArgs
'Usage
Dim instance As DownloadStringCompletedEventArgs

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 Shared Sub DownloadStringInBackground2(ByVal address As String)

			Dim client As WebClient = New WebClient()

			'  Specify that the DownloadStringCallback2 method gets called 
			'  when the download completes. 
			AddHandler client.DownloadStringCompleted, AddressOf DownloadStringCallback2
                        Dim uri as Uri = New Uri(address)
			client.DownloadStringAsync(uri)
		End Sub
// Sample call : DownloadStringInBackground2 ("http://www.contoso.com/GameScores.html");
void DownloadStringInBackground2 (String* address)
{
    WebClient* client = new WebClient ();

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

The following method is called when the download completes.

Private Shared Sub DownloadStringCallback2(ByVal sender As Object, ByVal e As DownloadStringCompletedEventArgs)

    '  If the request was not canceled and did not throw 
    '  an exception, display the resource. 
    If e.Cancelled = False AndAlso e.Error Is Nothing Then 

        Dim textString As String = CStr(e.Result)
        Console.WriteLine(textString)
    End If 
End Sub
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 == 0)
    {
        String* textString = dynamic_cast<String*>(e->Result);

        Console::WriteLine (textString);
    }
}

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

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
Show: