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

HttpWebRequest.EndGetRequestStream Method

Ends an asynchronous request for a Stream object to use to write data.

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

public:
virtual Stream^ EndGetRequestStream (
	IAsyncResult^ asyncResult
) override
public Stream EndGetRequestStream (
	IAsyncResult asyncResult
)
public override function EndGetRequestStream (
	asyncResult : IAsyncResult
) : Stream
Not applicable.

Parameters

asyncResult

The pending request for a stream.

Return Value

A Stream to use to write request data.
Exception typeCondition

ArgumentNullException

asyncResult is a null reference (Nothing in Visual Basic).

IOException

The request did not complete, and no stream is available.

ArgumentException

asyncResult was not returned by the current instance from a call to BeginGetRequestStream.

InvalidOperationException

This method was called previously using asyncResult.

WebException

Abort was previously called.

-or-

An error occurred while processing the request.

The EndGetRequestStream method completes an asynchronous request for a stream that was started by the BeginGetRequestStream method. After the Stream object has been returned, you can send data with the HttpWebRequest by using the Stream.Write method.

NoteNote:

You must set the value of the ContentLength property before writing data to the stream.

Caution noteCaution:

You must call the Stream.Close method to close the stream and release the connection for reuse. Failure to close the stream causes your application to run out of connections.

NoteNote:

This member outputs trace information when you enable network tracing in your application. For more information, see Network Tracing.

The following code example uses the EndGetRequestStream method to end an asynchronous request for a stream instance.

#using <System.dll>

using namespace System;
using namespace System::Net;
using namespace System::IO;
using namespace System::Text;
using namespace System::Threading;
ref class HttpWebRequestBeginGetRequest
{
public:
   static ManualResetEvent^ allDone = gcnew ManualResetEvent( false );
   static void Main()
   {
      
      // Create a new HttpWebRequest object.
      HttpWebRequest^ request = dynamic_cast<HttpWebRequest^>(WebRequest::Create( "http://www.contoso.com/example.aspx" ));
      
      // Set the ContentType property.
      request->ContentType = "application/x-www-form-urlencoded";
      
      // Set the Method property to 'POST' to post data to the Uri.
      request->Method = "POST";
      
      // Start the asynchronous operation.    
      AsyncCallback^ del = gcnew AsyncCallback( ReadCallback );
      request->BeginGetRequestStream( del, request );
      
      // Keep the main thread from continuing while the asynchronous
      // operation completes. A real world application
      // could do something useful such as updating its user interface. 
      allDone->WaitOne();
      HttpWebResponse^ response = dynamic_cast<HttpWebResponse^>(request->GetResponse());
      Stream^ streamResponse = response->GetResponseStream();
      StreamReader^ streamRead = gcnew StreamReader( streamResponse );
      String^ responseString = streamRead->ReadToEnd();
      Console::WriteLine( responseString );
      
      // Close Stream object.
      streamResponse->Close();
      streamRead->Close();
      
      // Release the HttpWebResponse.
      response->Close();
   }


private:
   static void ReadCallback( IAsyncResult^ asynchronousResult )
   {
      HttpWebRequest^ request = dynamic_cast<HttpWebRequest^>(asynchronousResult->AsyncState);
      
      // End the operation.
      Stream^ postStream = request->EndGetRequestStream( asynchronousResult );
      Console::WriteLine( "Please enter the input data to be posted:" );
      String^ postData = Console::ReadLine();
      
      // Convert the string into Byte array.
      array<Byte>^ByteArray = Encoding::UTF8->GetBytes( postData );
      
      // Write to the request stream.
      postStream->Write( ByteArray, 0, postData->Length );
      postStream->Close();
      allDone->Set();
   }

};

void main()
{
   HttpWebRequestBeginGetRequest::Main();
}


import System.*;
import System.Net.*;
import System.IO.*;
import System.Text.*;
import System.Threading.*;

class HttpWebRequestBeginGetRequest
{
    public static ManualResetEvent allDone = new ManualResetEvent(false);

    public static void main(String[] args)
    {
        // Create a new HttpWebRequest object.
        HttpWebRequest request = (HttpWebRequest)(WebRequest.Create(
            "http://www.contoso.com/example.aspx"));
        // Set the ContentType property. 
        request.set_ContentType("application/x-www-form-urlencoded");
        // Set the Method property to 'POST' to post data to the URI.
        request.set_Method("POST");
        // Start the asynchronous operation.    
        request.BeginGetRequestStream(new AsyncCallback(ReadCallback), request);
        // Keep the main thread from continuing while the asynchronous
        // operation completes. A real world application
        // could do something useful such as updating its user interface. 
        allDone.WaitOne();

        // Get the response.
        HttpWebResponse response = (HttpWebResponse)(request.GetResponse());
        Stream streamResponse = response.GetResponseStream();
        StreamReader streamRead = new StreamReader(streamResponse);
        String responseString = streamRead.ReadToEnd();
        Console.WriteLine(responseString);

        // Close the stream object.
        streamResponse.Close();
        streamRead.Close();
        // Release the HttpWebResponse.
        response.Close();
    } //main

    private static void ReadCallback(IAsyncResult asynchronousResult)
    {
        HttpWebRequest request = (HttpWebRequest)
            (asynchronousResult.get_AsyncState());
        // End the operation.
        Stream postStream = request.EndGetRequestStream(asynchronousResult);
        Console.WriteLine("Please enter the input data to be posted:");
        String postData = Console.ReadLine();
        // Convert the string into a byte array.
        ubyte byteArray[] = Encoding.get_UTF8().GetBytes(postData);
        // Write to the request stream.
        postStream.Write(byteArray, 0, postData.get_Length());
        postStream.Close();
        allDone.Set();
    } //ReadCallback
} //HttpWebRequestBeginGetRequest 

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0, 1.1, 1.0

.NET Compact Framework

Supported in: 2.0, 1.0
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.