WebClient.OpenWriteTaskAsync Method

Definition

Opens a stream for writing data to the specified resource as an asynchronous operation using a task object. These methods do not block the calling thread.

Overloads

OpenWriteTaskAsync(String)

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

OpenWriteTaskAsync(Uri)

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

OpenWriteTaskAsync(String, String)

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

OpenWriteTaskAsync(Uri, String)

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

OpenWriteTaskAsync(String)

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

public:
 System::Threading::Tasks::Task<System::IO::Stream ^> ^ OpenWriteTaskAsync(System::String ^ address);
public System.Threading.Tasks.Task<System.IO.Stream> OpenWriteTaskAsync (string address);
[System.Runtime.InteropServices.ComVisible(false)]
public System.Threading.Tasks.Task<System.IO.Stream> OpenWriteTaskAsync (string address);
member this.OpenWriteTaskAsync : string -> System.Threading.Tasks.Task<System.IO.Stream>
[<System.Runtime.InteropServices.ComVisible(false)>]
member this.OpenWriteTaskAsync : string -> System.Threading.Tasks.Task<System.IO.Stream>
Public Function OpenWriteTaskAsync (address As String) As Task(Of Stream)

Parameters

address
String

The URI of the resource to receive the data.

Returns

The task object representing the asynchronous operation. The Result property on the task object returns a Stream used to write data to the resource.

Attributes

Exceptions

The address parameter is null.

The URI formed by combining BaseAddress and address is invalid.

-or-

An error occurred while opening the stream.

Remarks

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.

Note

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

In .NET Framework and .NET Core 1.0, you can cancel asynchronous operations that have not completed by calling 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 .NET Framework.

See also

Applies to

OpenWriteTaskAsync(Uri)

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

public:
 System::Threading::Tasks::Task<System::IO::Stream ^> ^ OpenWriteTaskAsync(Uri ^ address);
public System.Threading.Tasks.Task<System.IO.Stream> OpenWriteTaskAsync (Uri address);
[System.Runtime.InteropServices.ComVisible(false)]
public System.Threading.Tasks.Task<System.IO.Stream> OpenWriteTaskAsync (Uri address);
member this.OpenWriteTaskAsync : Uri -> System.Threading.Tasks.Task<System.IO.Stream>
[<System.Runtime.InteropServices.ComVisible(false)>]
member this.OpenWriteTaskAsync : Uri -> System.Threading.Tasks.Task<System.IO.Stream>
Public Function OpenWriteTaskAsync (address As Uri) As Task(Of Stream)

Parameters

address
Uri

The URI of the resource to receive the data.

Returns

The task object representing the asynchronous operation. The Result property on the task object returns a Stream used to write data to the resource.

Attributes

Exceptions

The address parameter is null.

The URI formed by combining BaseAddress and address is invalid.

-or-

An error occurred while opening the stream.

Remarks

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.

Note

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

In .NET Framework and .NET Core 1.0, you can cancel asynchronous operations that have not completed by calling 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 .NET Framework.

Applies to

OpenWriteTaskAsync(String, String)

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

public:
 System::Threading::Tasks::Task<System::IO::Stream ^> ^ OpenWriteTaskAsync(System::String ^ address, System::String ^ method);
public System.Threading.Tasks.Task<System.IO.Stream> OpenWriteTaskAsync (string address, string? method);
public System.Threading.Tasks.Task<System.IO.Stream> OpenWriteTaskAsync (string address, string method);
[System.Runtime.InteropServices.ComVisible(false)]
public System.Threading.Tasks.Task<System.IO.Stream> OpenWriteTaskAsync (string address, string method);
member this.OpenWriteTaskAsync : string * string -> System.Threading.Tasks.Task<System.IO.Stream>
[<System.Runtime.InteropServices.ComVisible(false)>]
member this.OpenWriteTaskAsync : string * string -> System.Threading.Tasks.Task<System.IO.Stream>
Public Function OpenWriteTaskAsync (address As String, method As String) As Task(Of Stream)

Parameters

address
String

The URI of the resource to receive the data.

method
String

The method used to send the data to the resource. If null, the default is POST for http and STOR for ftp.

Returns

The task object representing the asynchronous operation. The Result property on the task object returns a Stream used to write data to the resource.

Attributes

Exceptions

The address parameter is null.

The URI formed by combining BaseAddress and address is invalid.

-or-

An error occurred while opening the stream.

Remarks

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.

Note

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.

In .NET Framework and .NET Core 1.0, you can cancel asynchronous operations that have not completed by calling 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 .NET Framework.

See also

Applies to

OpenWriteTaskAsync(Uri, String)

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

public:
 System::Threading::Tasks::Task<System::IO::Stream ^> ^ OpenWriteTaskAsync(Uri ^ address, System::String ^ method);
public System.Threading.Tasks.Task<System.IO.Stream> OpenWriteTaskAsync (Uri address, string? method);
public System.Threading.Tasks.Task<System.IO.Stream> OpenWriteTaskAsync (Uri address, string method);
[System.Runtime.InteropServices.ComVisible(false)]
public System.Threading.Tasks.Task<System.IO.Stream> OpenWriteTaskAsync (Uri address, string method);
member this.OpenWriteTaskAsync : Uri * string -> System.Threading.Tasks.Task<System.IO.Stream>
[<System.Runtime.InteropServices.ComVisible(false)>]
member this.OpenWriteTaskAsync : Uri * string -> System.Threading.Tasks.Task<System.IO.Stream>
Public Function OpenWriteTaskAsync (address As Uri, method As String) As Task(Of Stream)

Parameters

address
Uri

The URI of the resource to receive the data.

method
String

The method used to send the data to the resource. If null, the default is POST for http and STOR for ftp.

Returns

The task object representing the asynchronous operation. The Result property on the task object returns a Stream used to write data to the resource.

Attributes

Exceptions

The address parameter is null.

The URI formed by combining BaseAddress and address is invalid.

-or-

An error occurred while opening the stream.

Remarks

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.

Note

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.

In .NET Framework and .NET Core 1.0, you can cancel asynchronous operations that have not completed by calling 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 .NET Framework.

See also

Applies to