WebClient.OpenWriteAsync Method (Uri, String, Object)

[ This article is for Windows Phone 8 developers. If you’re developing for Windows 10, see the latest documentation. ]

Opens a stream for writing data to the specified resource, using the specified method. This method does not block the calling thread.

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

Syntax

Public Sub OpenWriteAsync ( _
    address As Uri, _
    method As String, _
    userToken As Object _
)
public void OpenWriteAsync(
    Uri address,
    string method,
    Object userToken
)

Parameters

  • address
    Type: System..::.Uri
    The URI of the resource to receive the data.
  • method
    Type: System..::.String
    The method used to send the data to the resource. If null, the default is POST for HTTP.
  • userToken
    Type: System..::.Object
    A user-defined object that is passed to the method invoked when the asynchronous operation completes

Exceptions

Exception Condition
ArgumentNullException

The address parameter is nullNothingnullptra null reference (Nothing in Visual Basic).

OutOfMemoryException

There is not enough memory to continue the execution of the program.

StackOverflowException

The execution stack overflowed because it contains too many nested method calls.

ThreadAbortException

A call was made to the Thread..::.Abort method to destroy a thread.

WebException

The URI formed by combining BaseAddress and address is invalid.

-or-

An error occurred while opening the stream.

Remarks

This method retrieves a writable stream that is used to send data to a resource. The stream is retrieved asynchronously using thread resources that are automatically allocated from the thread pool. To receive notification when the stream is available, add an event handler to the OpenWriteCompleted event. The contents of the stream are sent to the server when you close the stream.

If the method parameter specifies a method that is not understood by the server, the underlying protocol classes determine what occurs. Typically, a WebException is thrown with the Status property set to indicate the error.

Asynchronous operations that have not completed can be canceled using the CancelAsync method.

This method does not block the calling thread while the stream is being opened.

If the BaseAddress property is not an empty string ("") and address does not contain an absolute URI, address must be a relative URI that is combined with BaseAddress to form the absolute URI of the requested data.

Version Information

Windows Phone OS

Supported in: 8.1, 8.0, 7.1, 7.0

Platforms

Windows Phone

See Also

Reference

WebClient Class

OpenWriteAsync Overload

System.Net Namespace