WebClient.OpenWriteTaskAsync Method (Uri, String)

.NET Framework 4.5

Opens a stream for writing data to the specified resource as an asynchronous operation using a task object.

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

[ComVisibleAttribute(false)]
[HostProtectionAttribute(SecurityAction.LinkDemand, ExternalThreading = true)]
public Task<Stream> OpenWriteTaskAsync(
	Uri address,
	string method
)

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 and STOR for ftp.

Return Value

Type: System.Threading.Tasks.Task<Stream>
Returns Task<TResult>.
The task object representing the asynchronous operation. The Result property on the task object returns a Stream used to write data to the resource.

ExceptionCondition
ArgumentNullException

The address parameter is null.

WebException

The URI formed by combining BaseAddress and address is invalid.

-or-

An error occurred while opening the stream.

This operation will not block. The returned Task<TResult> object will complete after the a writable stream to the data resource has been opened. This method does not block the calling thread while the stream is opening.

This method retrieves a Stream instance used to write data to the resource specified by the address parameter. The stream is obtained using thread resources that are automatically allocated from the thread pool.

NoteNote

You must call Stream.Close when you are finished with the Stream to avoid running out of system resources.

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.

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. If the QueryString property is not an empty string, it is appended to address.

This method uses the STOR command to upload an FTP resource. For an HTTP resource, the POST method is used.

This member outputs trace information when you enable network tracing in your application. For more information, see Network Tracing in the .NET 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.

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft