This documentation is archived and is not being maintained.

WebRequest::BeginGetResponse Method

When overridden in a descendant class, begins an asynchronous request for an Internet resource.

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

[HostProtectionAttribute(SecurityAction::LinkDemand, ExternalThreading = true)]
public:
virtual IAsyncResult^ BeginGetResponse(
	AsyncCallback^ callback, 
	Object^ state
)

Parameters

callback
Type: System::AsyncCallback
The AsyncCallback delegate.
state
Type: System::Object
An object containing state information for this asynchronous request.

Return Value

Type: System::IAsyncResult
An IAsyncResult that references the asynchronous request.

ExceptionCondition
NotImplementedException

Any attempt is made to access the method, when the method is not overridden in a descendant class.

The BeginGetResponse method starts an asynchronous request for a response. The callback method that implements the AsyncCallback delegate uses the EndGetResponse method to return the WebResponse from the Internet resource.

NoteNote

The WebRequest class is an abstract class. The actual behavior of WebRequest instances at run time is determined by the descendant class returned by the WebRequest::Create method. For more information about default values and exceptions, see the documentation for the descendant classes, such as HttpWebRequest and FileWebRequest.

NoteNote

If a WebException is thrown, use the Response and Status properties of the exception to determine the response from the server.

NoteNote

The HostProtectionAttribute attribute applied to this type or member has the following Resources property value: ExternalThreading. The HostProtectionAttribute does not affect desktop applications (which are typically started by double-clicking an icon, typing a command, or entering a URL in a browser). For more information, see the HostProtectionAttribute class or SQL Server Programming and Host Protection Attributes.

The following example uses BeginGetResponse to asynchronously request the target resource. When the resource has been obtained, the specified callback method will be executed.


#using <System.dll>

using namespace System;
using namespace System::Net;
using namespace System::IO;
using namespace System::Text;
using namespace System::Threading;
public ref class RequestState
{
private:

   // This class stores the state of the request.
   literal int BUFFER_SIZE = 1024;

public:
   StringBuilder^ requestData;
   array<Byte>^bufferRead;
   WebRequest^ request;
   WebResponse^ response;
   Stream^ responseStream;
   RequestState()
   {
      bufferRead = gcnew array<Byte>(BUFFER_SIZE);
      requestData = gcnew StringBuilder( "" );
      request = nullptr;
      responseStream = nullptr;
   }

};

ref class WebRequest_BeginGetResponse
{
public:
   static ManualResetEvent^ allDone = gcnew ManualResetEvent( false );
   literal int BUFFER_SIZE = 1024;
   static void RespCallback( IAsyncResult^ asynchronousResult )
   {
      try
      {

         // Set the State of request to asynchronous.
         RequestState^ myRequestState = dynamic_cast<RequestState^>(asynchronousResult->AsyncState);
         WebRequest^ myWebRequest1 = myRequestState->request;

         // End the Asynchronous response.
         myRequestState->response = myWebRequest1->EndGetResponse( asynchronousResult );

         // Read the response into a 'Stream' object.
         Stream^ responseStream = myRequestState->response->GetResponseStream();
         myRequestState->responseStream = responseStream;

         // Begin the reading of the contents of the HTML page and print it to the console.
         IAsyncResult^ asynchronousResultRead = responseStream->BeginRead( myRequestState->bufferRead, 0, BUFFER_SIZE, gcnew AsyncCallback( ReadCallBack ), myRequestState );
      }
      catch ( WebException^ e ) 
      {
         Console::WriteLine( "WebException raised!" );
         Console::WriteLine( "\n {0}", e->Message );
         Console::WriteLine( "\n {0}", e->Status );
      }
      catch ( Exception^ e ) 
      {
         Console::WriteLine( "Exception raised!" );
         Console::WriteLine( "Source : {0}", e->Source );
         Console::WriteLine( "Message : {0}", e->Message );
      }

   }

   static void ReadCallBack( IAsyncResult^ asyncResult )
   {
      try
      {

         // Result state is set to AsyncState.
         RequestState^ myRequestState = dynamic_cast<RequestState^>(asyncResult->AsyncState);
         Stream^ responseStream = myRequestState->responseStream;
         int read = responseStream->EndRead( asyncResult );

         // Read the contents of the HTML page and then print to the console.
         if ( read > 0 )
         {
            myRequestState->requestData->Append( Encoding::ASCII->GetString( myRequestState->bufferRead, 0, read ) );
            IAsyncResult^ asynchronousResult = responseStream->BeginRead( myRequestState->bufferRead, 0, BUFFER_SIZE, gcnew AsyncCallback( ReadCallBack ), myRequestState );
         }
         else
         {
            Console::WriteLine( "\nThe HTML page Contents are:  " );
            if ( myRequestState->requestData->Length > 1 )
            {
               String^ sringContent;
               sringContent = myRequestState->requestData->ToString();
               Console::WriteLine( sringContent );
            }
            Console::WriteLine( "\nPress 'Enter' key to continue........" );
            responseStream->Close();
            allDone->Set();
         }
      }
      catch ( WebException^ e ) 
      {
         Console::WriteLine( "WebException raised!" );
         Console::WriteLine( "\n {0}", e->Message );
         Console::WriteLine( "\n {0}", e->Status );
      }
      catch ( Exception^ e ) 
      {
         Console::WriteLine( "Exception raised!" );
         Console::WriteLine( "Source : {0}", e->Source );
         Console::WriteLine( "Message : {0}", e->Message );
      }

   }

};

int main()
{
   try
   {

      // Create a new webrequest to the mentioned URL.
      WebRequest^ myWebRequest = WebRequest::Create( "http://www.contoso.com" );

      // Please, set the proxy to a correct value.
      WebProxy^ proxy = gcnew WebProxy( "myproxy:80" );
      proxy->Credentials = gcnew NetworkCredential( "srikun","simrin123" );
      myWebRequest->Proxy = proxy;

      // Create a new instance of the RequestState.
      RequestState^ myRequestState = gcnew RequestState;

      // The 'WebRequest' object is associated to the 'RequestState' object.
      myRequestState->request = myWebRequest;

      // Start the Asynchronous call for response.
      IAsyncResult^ asyncResult = dynamic_cast<IAsyncResult^>(myWebRequest->BeginGetResponse( gcnew AsyncCallback( WebRequest_BeginGetResponse::RespCallback ), myRequestState ));
      WebRequest_BeginGetResponse::allDone->WaitOne();

      // Release the WebResponse resource.
      myRequestState->response->Close();
      Console::Read();
   }
   catch ( WebException^ e ) 
   {
      Console::WriteLine( "WebException raised!" );
      Console::WriteLine( "\n {0}", e->Message );
      Console::WriteLine( "\n {0}", e->Status );
   }
   catch ( Exception^ e ) 
   {
      Console::WriteLine( "Exception raised!" );
      Console::WriteLine( "Source : {0}", e->Source );
      Console::WriteLine( "Message : {0}", e->Message );
   }

}



.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Show: