WebRequest.GetRequestStream Method (System.Net)

GetRequestStream Method

.NET Framework Class Library

WebRequest..::.GetRequestStream 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)

Syntax

Visual Basic (Declaration)

Public Overridable Function GetRequestStream As Stream

Visual Basic (Usage)

Dim instance As WebRequest
Dim returnValue As Stream

returnValue = instance.GetRequestStream()

public virtual Stream GetRequestStream()

Visual C++

public:
virtual Stream^ GetRequestStream()

JScript

public function GetRequestStream() : Stream

Return Value

Type: System.IO..::.Stream
A Stream for writing data to the Internet resource.

Exceptions

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

Remarks

The GetRequestStream method initiates a request to send data to the Internet resource and returns a Stream instance for sending data to the Internet resource.

The GetRequestStream method provides synchronous access to the Stream. For asynchronous access, use the BeginGetRequestStream and EndGetRequestStream methods.

Note:
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.

Examples

The following example uses the GetRequestStream method to obtain a stream and then writes data that stream.

Visual Basic


' Set the 'ContentType' property of the WebRequest.
myWebRequest.ContentType = "application/x-www-form-urlencoded"

' Set the 'ContentLength' property of the WebRequest.
myWebRequest.ContentLength = byteArray.Length
Dim newStream As Stream = myWebRequest.GetRequestStream()
newStream.Write(byteArray, 0, byteArray.Length)

' Close the Stream object.
newStream.Close()

' Assign the response object of 'WebRequest' to a 'WebResponse' variable.
Dim myWebResponse As WebResponse = myWebRequest.GetResponse()

            // Set the 'ContentType' property of the WebRequest.
            myWebRequest.ContentType="application/x-www-form-urlencoded";

            // Set the 'ContentLength' property of the WebRequest.
            myWebRequest.ContentLength=byteArray.Length;
            Stream newStream=myWebRequest.GetRequestStream();
            newStream.Write(byteArray,0,byteArray.Length);

            // Close the Stream object.
            newStream.Close();

            // Assign the response object of 'WebRequest' to a 'WebResponse' variable.
            WebResponse myWebResponse=myWebRequest.GetResponse();

Visual C++

// Set the 'ContentType' property of the WebRequest.
myWebRequest->ContentType = "application/x-www-form-urlencoded";

// Set the 'ContentLength' property of the WebRequest.
myWebRequest->ContentLength = byteArray->Length;
Stream^ newStream = myWebRequest->GetRequestStream();
newStream->Write( byteArray, 0, byteArray->Length );

// Close the Stream object.
newStream->Close();

// Assign the response object of 'WebRequest' to a 'WebResponse' variable.
WebResponse^ myWebResponse = myWebRequest->GetResponse();

CPP_OLD

// Set the 'ContentType' property of the WebRequest.
myWebRequest->ContentType=S"application/x-www-form-urlencoded";

// Set the 'ContentLength' property of the WebRequest.
myWebRequest->ContentLength=byteArray->Length;
Stream* newStream=myWebRequest->GetRequestStream();
newStream->Write(byteArray, 0, byteArray->Length);

// Close the Stream object.
newStream->Close();

// Assign the response object of 'WebRequest' to a 'WebResponse' variable.
WebResponse* myWebResponse=myWebRequest->GetResponse();

Platforms

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.

Version Information

.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

Reference

WebRequest Class

WebRequest Members

System.Net Namespace

BeginGetRequestStream

Other Resources

Using Streams on the Network