OpenReadCompletedEventArgs Class

Definition

Namespace:

System.Net

Assembly:

System.Net.WebClient.dll

Source:

WebClient.cs

Provides data for the OpenReadCompleted event.

public ref class OpenReadCompletedEventArgs : System::ComponentModel::AsyncCompletedEventArgs

public class OpenReadCompletedEventArgs : System.ComponentModel.AsyncCompletedEventArgs

type OpenReadCompletedEventArgs = class
    inherit AsyncCompletedEventArgs

Public Class OpenReadCompletedEventArgs
Inherits AsyncCompletedEventArgs

Inheritance

Object

EventArgs

AsyncCompletedEventArgs

OpenReadCompletedEventArgs

Examples

The following code example demonstrates downloading a resource for reading.

void OpenResourceForReading2( String^ address )
{
   WebClient^ client = gcnew WebClient;
   Uri ^uri = gcnew Uri(address);

   client->OpenReadCompleted += gcnew OpenReadCompletedEventHandler( OpenReadCallback2 );
   client->OpenReadAsync( uri );
}

public static void OpenResourceForReading2(string address)
{
    WebClient client = new WebClient();
    Uri uri = new Uri(address);

    client.OpenReadCompleted += new OpenReadCompletedEventHandler(OpenReadCallback2);
    client.OpenReadAsync(uri);
}

Public Shared Sub OpenResourceForReading2(ByVal address As String)

    Dim client As WebClient = New WebClient()
    AddHandler client.OpenReadCompleted, AddressOf OpenReadCallback2
                Dim uri as Uri = New Uri(address)
    client.OpenReadAsync(uri)
End Sub

The following method is called when the download completes.

void OpenReadCallback2( Object^ /*sender*/, OpenReadCompletedEventArgs^ e )
{
   Stream^ reply = nullptr;
   StreamReader^ s = nullptr;
   try
   {
      reply = dynamic_cast<Stream^>(e->Result);
      s = gcnew StreamReader( reply );
      Console::WriteLine( s->ReadToEnd() );
   }
   finally
   {
      if ( s != nullptr )
      {
         s->Close();
      }
      if ( reply != nullptr )
      {
         reply->Close();
      }
   }

}

private static void OpenReadCallback2(Object sender, OpenReadCompletedEventArgs e)
{
    Stream reply = null;
    StreamReader s = null;

    try
    {
        reply = (Stream)e.Result;
        s = new StreamReader(reply);
        Console.WriteLine(s.ReadToEnd());
    }
    finally
    {
        if (s != null)
        {
            s.Close();
        }

        if (reply != null)
        {
            reply.Close();
        }
    }
}

Private Shared Sub OpenReadCallback2(ByVal sender As Object, ByVal e As OpenReadCompletedEventArgs)

    Dim reply As Stream = Nothing
    Dim s As StreamReader = Nothing

    Try

        reply = CType(e.Result, Stream)
        s = New StreamReader(reply)
        Console.WriteLine(s.ReadToEnd())
    Finally

        If Not s Is Nothing Then

            s.Close()
        End If

        If Not reply Is Nothing Then

            reply.Close()
        End If
    End Try
End Sub

Remarks

Instances of this class are passed to OpenReadCompletedEventHandler methods.

Properties

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 a readable stream that contains data downloaded by a DownloadDataAsync method.
UserState	Gets the unique identifier for the asynchronous task. (Inherited from AsyncCompletedEventArgs)

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (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)