System.Net Namespace


.NET Framework Class Library
DownloadStringCompletedEventArgs Class

Provides data for the DownloadStringCompleted event.

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

Visual Basic (Declaration)
Public Class DownloadStringCompletedEventArgs _
    Inherits AsyncCompletedEventArgs
Visual Basic (Usage)
Dim instance As DownloadStringCompletedEventArgs
C#
public class DownloadStringCompletedEventArgs : AsyncCompletedEventArgs
Visual C++
public ref class DownloadStringCompletedEventArgs : public AsyncCompletedEventArgs
JScript
public class DownloadStringCompletedEventArgs extends AsyncCompletedEventArgs
Remarks

Instances of this class are passed to the DownloadStringCompletedEventHandler.

Examples

The following code example demonstrates downloading a string asynchronously.

Visual Basic
        '  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

C#
// 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);
}

Visual C++
// Sample call : DownloadStringInBackground2 ("http://www.contoso.com/GameScores.html");
void DownloadStringInBackground2( String^ address )
{
   WebClient^ client = gcnew WebClient;
   Uri ^uri = gcnew Uri(address);

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


The following method is called when the download completes.

Visual Basic
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

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

Visual C++
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 == nullptr )
   {
      String^ textString = dynamic_cast<String^>(e->Result);
      Console::WriteLine( textString );
   }
}


Inheritance Hierarchy

System..::.Object
  System..::.EventArgs
    System.ComponentModel..::.AsyncCompletedEventArgs
      System.Net..::.DownloadStringCompletedEventArgs
Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Platforms

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.
Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0
See Also

Reference

Tags :


Page view tracker