This documentation is archived and is not being maintained.

HttpWebRequest.BeginGetRequestStream Method

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

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

'Declaration
<HostProtectionAttribute(SecurityAction.LinkDemand, ExternalThreading := True)> _
Public Overrides Function BeginGetRequestStream ( _
	callback As AsyncCallback, _
	state As Object _
) As IAsyncResult
'Usage
Dim instance As HttpWebRequest 
Dim callback As AsyncCallback 
Dim state As Object 
Dim returnValue As IAsyncResult 

returnValue = instance.BeginGetRequestStream(callback, _
	state)

Parameters

callback
Type: System.AsyncCallback

The AsyncCallback delegate.

state
Type: System.Object

The state object for this request.

Return Value

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

ExceptionCondition
ProtocolViolationException

The Method property is GET or HEAD.

-or-

KeepAlive is true, AllowWriteStreamBuffering is false, ContentLength is -1, SendChunked is false, and Method is POST or PUT.

InvalidOperationException

The stream is being used by a previous call to BeginGetRequestStream

-or-

TransferEncoding is set to a value and SendChunked is false.

-or-

The thread pool is running out of threads.

NotSupportedException

The request cache validator indicated that the response for this request can be served from the cache; however, requests that write data must not use the cache. This exception can occur if you are using a custom cache validator that is incorrectly implemented.

WebException

Abort was previously called.

ObjectDisposedException

In a .NET Compact Framework application, a request stream with zero content length was not obtained and closed correctly. For more information about handling zero content length requests, see Network Programming in the .NET Compact Framework.

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 BeginGetRequestStream method starts an asynchronous request for a stream used to send data for the HttpWebRequest. The asynchronous callback method uses the EndGetRequestStream method to return the actual stream.

The BeginGetRequestStream method requires some synchronous setup tasks to complete (DNS resolution, proxy detection, and TCP socket connection, for example) before this method becomes asynchronous. As a result, this method should never be called on a user interface (UI) thread because it might take some time, typically several seconds. In some environments where the webproxy scripts are not configured properly, this can take 60 seconds or more. The default value for the downloadTime attribute on the <webProxyScipt> config file element is one minute which accounts for most of the potential time delay.

To learn more about the thread pool, see The Managed Thread Pool.

NoteNote:

Your application cannot mix synchronous and asynchronous methods for a particular request. If you call the BeginGetRequestStream method, you must use the BeginGetResponse method to retrieve the response.

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 BeginGetRequestStream method to make an asynchronous request for a stream instance.

Imports System
Imports System.Net
Imports System.IO
Imports System.Text
Imports System.Threading
Imports Microsoft.VisualBasic

Class HttpWebRequestBeginGetRequest
    Public Shared allDone As New ManualResetEvent(False)

    Shared Sub Main()


        ' Create a new HttpWebRequest object. 
        Dim request As HttpWebRequest = CType(WebRequest.Create("http://www.contoso.com/example.aspx"), _
                 HttpWebRequest)

        ' 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.		 
        Dim result As IAsyncResult = _
            CType(request.BeginGetRequestStream(AddressOf GetRequestStreamCallback, request), _
            IAsyncResult)

        ' 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()
    End Sub ' Main

    Private Shared Sub GetRequestStreamCallback(ByVal asynchronousResult As IAsyncResult)
        Dim request As HttpWebRequest = CType(asynchronousResult.AsyncState, HttpWebRequest)

        ' End the operation 
        Dim postStream As Stream = request.EndGetRequestStream(asynchronousResult)
        Console.WriteLine("Please enter the input data to be posted:")
        Dim postData As [String] = Console.ReadLine()

        '  Convert the string into byte array. 
        Dim byteArray As Byte() = Encoding.UTF8.GetBytes(postData)

        ' Write to the stream.
        postStream.Write(byteArray, 0, postData.Length)
        postStream.Close()

        ' Start the asynchronous operation to get the response 
        Dim result As IAsyncResult = _
            CType(request.BeginGetResponse(AddressOf GetResponseCallback, request), _
            IAsyncResult)
    End Sub ' ReadRequestStreamCallback

    Private Shared Sub GetResponseCallback(ByVal asynchronousResult As IAsyncResult)
        Dim request As HttpWebRequest = CType(asynchronousResult.AsyncState, HttpWebRequest)

        '  Get the response. 
        Dim response As HttpWebResponse = CType(request.EndGetResponse(asynchronousResult), _
           HttpWebResponse)

        Dim streamResponse As Stream = response.GetResponseStream()
        Dim streamRead As New StreamReader(streamResponse)
        Dim responseString As String = streamRead.ReadToEnd()

        Console.WriteLine(responseString)

        ' Close Stream object.
        streamResponse.Close()
        streamRead.Close()

        ' Release the HttpWebResponse.
        allDone.Set()
        response.Close()
    End Sub ' ReadResponseCallback

End Class ' HttpWebRequest_BeginGetRequest
#using <mscorlib.dll>
#using <System.dll>
using namespace System;
using namespace System::Net;
using namespace System::IO;
using namespace System::Text;
using namespace System::Threading;

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

public:
	static void Main() {

        // Create a new HttpWebRequest object.
        HttpWebRequest* request =
    dynamic_cast<HttpWebRequest*> (WebRequest::Create(S"http://www.contoso.com/example.aspx"));
        // Set the ContentType property.
        request->ContentType=S"application/x-www-form-urlencoded";
        // Set the Method property to 'POST' to post data to the Uri.
        request->Method=S"POST";

        // Start the asynchronous operation.    
		AsyncCallback* del = 	new AsyncCallback(0,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 = new 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(S"Please enter the input data to be posted:");
         String * postData = Console::ReadLine();

         // Convert the string into Byte 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();
}

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, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC

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, 1.1, 1.0

.NET Compact Framework

Supported in: 3.5, 2.0, 1.0
Show: