WebRequest.GetRequestStreamAsync Method

Definition

Namespace:

System.Net

Assembly:

System.Net.Requests.dll

Source:

WebRequest.cs

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

public:
 virtual System::Threading::Tasks::Task<System::IO::Stream ^> ^ GetRequestStreamAsync();

public virtual System.Threading.Tasks.Task<System.IO.Stream> GetRequestStreamAsync ();

abstract member GetRequestStreamAsync : unit -> System.Threading.Tasks.Task<System.IO.Stream>
override this.GetRequestStreamAsync : unit -> System.Threading.Tasks.Task<System.IO.Stream>

Public Overridable Function GetRequestStreamAsync () As Task(Of Stream)

Returns

Task<Stream>

The task object representing the asynchronous operation.

Remarks

Caution

WebRequest, HttpWebRequest, ServicePoint, and WebClient are obsolete, and you shouldn't use them for new development. Use HttpClient instead.

This operation will not block. The returned Task<TResult> object will complete when the Stream for writing data to the Internet resource is available.

After you call GetRequestStreamAsync, make sure you close the request stream before you call GetResponseAsync.

This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as ArgumentException, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by GetRequestStream().