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

DownloadStringCompletedEventHandler Delegate

Represents the method that will handle the DownloadStringCompleted event of a WebClient.

Namespace:  System.Net
Assembly:  System (in System.dll)
'Declaration
Public Delegate Sub DownloadStringCompletedEventHandler ( _
	sender As Object, _
	e As DownloadStringCompletedEventArgs _
)
'Usage
Dim instance As New DownloadStringCompletedEventHandler(AddressOf HandlerMethod)

Parameters

sender
Type: System.Object

The source of the event.

e
Type: System.Net.DownloadStringCompletedEventArgs

A DownloadStringCompletedEventArgs that contains event data.

When you create a DownloadStringCompletedEventHandler delegate, you identify the method that will handle the event. To associate the event with your event handler, add an instance of the delegate to the event. The event handler is called whenever the event occurs, unless you remove the delegate. For more information about event handler delegates, see Events and Delegates.

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);
    }
}

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.