EndGetRequestStream Method

WebRequest.EndGetRequestStream Method

When overridden in a descendant class, returns a Stream for writing data to the Internet resource.

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

'Declaration
Public Overridable Function EndGetRequestStream ( _
	asyncResult As IAsyncResult _
) As Stream
'Usage
Dim instance As WebRequest
Dim asyncResult As IAsyncResult
Dim returnValue As Stream

returnValue = instance.EndGetRequestStream(asyncResult)
public Stream EndGetRequestStream (
	IAsyncResult asyncResult
)
public function EndGetRequestStream (
	asyncResult : IAsyncResult
) : Stream
Not applicable.

Parameters

asyncResult

An IAsyncResult that references a pending request for a stream.

Return Value

A Stream to write data to.

Exception typeCondition

NotImplementedException

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

The EndGetRequestStream method completes an asynchronous stream request that was started by the BeginGetRequestStream method.

NoteNote:

To avoid timing issues with garbage collection, be sure to close the response stream by calling the Close method on the stream returned by GetResponseStream after calling EndGetResponse.

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.

The following example obtains and uses the request stream by calling the EndGetRequestStream. The EndGetRequestStream method completes the asynchronous call to BeginGetRequestStream.

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

Public Class RequestState
    ' This class stores the request state of the request.
    Public request As WebRequest
    
    Public Sub New()
        request = Nothing
    End Sub ' New
End Class ' RequestState


Class WebRequest_BeginGetRequeststream
    Public Shared allDone As New ManualResetEvent(False)
    
    Shared Sub Main()
          ' Create a new request.
            Dim myWebRequest As WebRequest = WebRequest.Create("http://www.contoso.com/codesnippets/next.asp")
 ' Create an instance of the RequestState and assign 
            ' myWebRequest' to it's request field.
            Dim myRequestState As New RequestState()
            myRequestState.request = myWebRequest
            myWebRequest.ContentType = "application/x-www-form-urlencoded"

            ' Set the 'Method' property  to 'POST' to post data to a Uri.
            myRequestState.request.Method = "POST"
            ' Start the asynchronous 'BeginGetRequestStream' method call.
            Dim r As IAsyncResult = CType(myWebRequest.BeginGetRequestStream(AddressOf ReadCallback, myRequestState), IAsyncResult)
            ' Pause the current thread until the async operation completes.
            allDone.WaitOne()
            ' Send the Post and get the response.
            Dim myWebResponse As WebResponse = myWebRequest.GetResponse()
            Console.WriteLine(ControlChars.Cr + "The string has been posted.")
            Console.WriteLine("Please wait for the response....")
            Dim streamResponse As Stream = myWebResponse.GetResponseStream()
            Dim streamRead As New StreamReader(streamResponse)
            Dim readBuff(256) As [Char]
            Dim count As Integer = streamRead.Read(readBuff, 0, 256)
            Console.WriteLine(ControlChars.Cr + "The contents of the HTML page are ")
            While count > 0
                Dim outputData As New [String](readBuff, 0, count)
                Console.WriteLine(outputData)
                count = streamRead.Read(readBuff, 0, 256)
            End While

           ' Close the Stream Object.
            streamResponse.Close()
            streamRead.Close()
            ' Release the HttpWebResponse Resource.
             myWebResponse.Close()
    End Sub ' Main
     
    Private Shared Sub ReadCallback(asynchronousResult As IAsyncResult)
            Dim myRequestState As RequestState = CType(asynchronousResult.AsyncState, RequestState)
            Dim myWebRequest As WebRequest = myRequestState.request
            ' End the request.
            Dim streamResponse As Stream = myWebRequest.EndGetRequestStream(asynchronousResult)
            ' Create a string that is to be posted to the uri.
            Console.WriteLine(ControlChars.Cr + "Please enter a string to be posted:")
            Dim postData As String = Console.ReadLine()
            Dim encoder As New ASCIIEncoding()
            ' Convert  the string into a byte array.
            Dim byteArray As Byte() = Encoding.UTF8.GetBytes(postData)
            ' Write the data to the stream.
            streamResponse.Write(byteArray, 0, postData.Length)
            streamResponse.Close()
            ' Allow the main thread to resume.
            allDone.Set()
    End Sub ' ReadCallback 
End Class ' WebRequest_BeginGetRequeststream 

import System.*;
import System.Net.*;
import System.IO.*;
import System.Text.*;
import System.Threading.*;
public class RequestState
{
    // This class stores the request state of the request.
    public WebRequest request;

    public RequestState()
    {
        request = null;
    } //RequestState
} //RequestState

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

    public static void main(String[] args)
    {
        // Create a new request to the mentioned URL.    
        WebRequest myWebRequest = WebRequest.Create("http://www.contoso.com");
        // Create an instance of the RequestState and assign 
        // 'myWebRequest' to it's request field.    
        RequestState myRequestState = new RequestState();
        myRequestState.request = myWebRequest;
        myWebRequest.set_ContentType("application/x-www-form-urlencoded");
        // Set the 'Method' property  to 'POST' to post data to a Uri.
        myRequestState.request.set_Method("POST");

        // Start the Asynchronous 'BeginGetRequestStream' method call.    
        IAsyncResult r = (IAsyncResult)(myWebRequest.BeginGetRequestStream(
            new AsyncCallback(ReadCallback), myRequestState));
        // Pause the current thread until the async operation completes.
        Console.WriteLine("main thread waiting...");
        allDone.WaitOne();
        // Assign the response object of 'WebRequest' to a 'WebResponse' 
        // variable.
        WebResponse myWebResponse = myWebRequest.GetResponse();
        Console.WriteLine("The string has been posted.");
        Console.WriteLine("Please wait for the response...");

        Stream streamResponse = myWebResponse.GetResponseStream();
        StreamReader streamRead = new StreamReader(streamResponse);
        char readBuff[] = new char[256];
        int count = streamRead.Read(readBuff, 0, 256);
        Console.WriteLine("\nThe contents of the HTML page are ");

        while (count > 0) {
            String outputData = new String(readBuff, 0, count);
            Console.Write(outputData);
            count = streamRead.Read(readBuff, 0, 256);
        }
        // Close the Stream Object.
        streamResponse.Close();
        streamRead.Close();
        // Release the HttpWebResponse Resource.
        myWebResponse.Close();
    } //main

    private static void ReadCallback(IAsyncResult asynchronousResult)
    {
        RequestState myRequestState = 
            (RequestState) asynchronousResult.get_AsyncState();
        WebRequest myWebRequest = myRequestState.request;
        // End the Asynchronus request.
        Stream streamResponse = myWebRequest.EndGetRequestStream(
            asynchronousResult);
        // Create a string that is to be posted to the uri.
        Console.WriteLine("Please enter a string to be posted:");
        String postData = Console.ReadLine();
        // Convert the string into a byte array.
        ubyte byteArray[] = Encoding.get_UTF8().GetBytes(postData);
        // Write the data to the stream.
        streamResponse.Write(byteArray, 0, postData.get_Length());
        streamResponse.Close();
        allDone.Set();
    } //ReadCallback
} //WebRequest_BeginGetRequeststream

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

Community Additions

ADD
Show:
© 2016 Microsoft