WebClient.UploadFileTaskAsync Method

Definition

Namespace:

System.Net

Assembly:

System.Net.WebClient.dll

Uploads the specified local file to a resource as an asynchronous operation using a task object. These methods do not block the calling thread.

Overloads

UploadFileTaskAsync(Uri, String, String)	Uploads the specified local file to a resource as an asynchronous operation using a task object.
UploadFileTaskAsync(String, String, String)	Uploads the specified local file to a resource as an asynchronous operation using a task object.
UploadFileTaskAsync(String, String)	Uploads the specified local file to a resource as an asynchronous operation using a task object.
UploadFileTaskAsync(Uri, String)	Uploads the specified local file to a resource as an asynchronous operation using a task object.

UploadFileTaskAsync(Uri, String, String)

Source:

WebClient.cs

Uploads the specified local file to a resource as an asynchronous operation using a task object.

public:
 System::Threading::Tasks::Task<cli::array <System::Byte> ^> ^ UploadFileTaskAsync(Uri ^ address, System::String ^ method, System::String ^ fileName);

public System.Threading.Tasks.Task<byte[]> UploadFileTaskAsync (Uri address, string? method, string fileName);

member this.UploadFileTaskAsync : Uri * string * string -> System.Threading.Tasks.Task<byte[]>

Public Function UploadFileTaskAsync (address As Uri, method As String, fileName As String) As Task(Of Byte())

Parameters

address

Uri

The URI of the resource to receive the file. For HTTP resources, this URI must identify a resource that can accept a request sent with the POST method, such as a script or ASP page.

method

String

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

fileName

String

The local file to send to the resource.

Returns

Task<Byte[]>

The task object representing the asynchronous operation. The Result property on the task object returns a Byte array containing the body of the response received from the resource when the file was uploaded.

Exceptions

ArgumentNullException

The address parameter is null.

-or-

The fileName parameter is null.

WebException

The URI formed by combining BaseAddress and address is invalid.

-or-

fileName is null, is Empty, contains invalid character, or the specified path to the file does not exist.

-or-

An error occurred while opening the stream.

-or-

There was no response from the server hosting the resource.

-or-

The Content-type header begins with multipart.

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 after the file has been uploaded to the resource. The file is sent asynchronously using thread resources that are automatically allocated from the thread pool.

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 (""), 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.

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

Note

This member outputs trace information when you enable network tracing in your application. For more information, see Network Tracing in .NET Framework.

UploadFileTaskAsync(String, String, String)

Source:

WebClient.cs

Uploads the specified local file to a resource as an asynchronous operation using a task object.

public:
 System::Threading::Tasks::Task<cli::array <System::Byte> ^> ^ UploadFileTaskAsync(System::String ^ address, System::String ^ method, System::String ^ fileName);

public System.Threading.Tasks.Task<byte[]> UploadFileTaskAsync (string address, string? method, string fileName);

member this.UploadFileTaskAsync : string * string * string -> System.Threading.Tasks.Task<byte[]>

Public Function UploadFileTaskAsync (address As String, method As String, fileName As String) As Task(Of Byte())

Parameters

address

String

The URI of the resource to receive the file. For HTTP resources, this URI must identify a resource that can accept a request sent with the POST method, such as a script or ASP page.

method

String

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

fileName

String

The local file to send to the resource.

Returns

Task<Byte[]>

The task object representing the asynchronous operation. The Result property on the task object returns a Byte array containing the body of the response received from the resource when the file was uploaded.

Exceptions

ArgumentNullException

The address parameter is null.

-or-

The fileName parameter is null.

WebException

The URI formed by combining BaseAddress and address is invalid.

-or-

fileName is null, is Empty, contains invalid character, or the specified path to the file does not exist.

-or-

An error occurred while opening the stream.

-or-

There was no response from the server hosting the resource.

-or-

The Content-type header begins with multipart.

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 after the file has been uploaded to the resource. The file is sent asynchronously using thread resources that are automatically allocated from the thread pool.

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 (""), 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.

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

Note

This member outputs trace information when you enable network tracing in your application. For more information, see Network Tracing in .NET Framework.

UploadFileTaskAsync(String, String)

Source:

WebClient.cs

Uploads the specified local file to a resource as an asynchronous operation using a task object.

public:
 System::Threading::Tasks::Task<cli::array <System::Byte> ^> ^ UploadFileTaskAsync(System::String ^ address, System::String ^ fileName);

public System.Threading.Tasks.Task<byte[]> UploadFileTaskAsync (string address, string fileName);

member this.UploadFileTaskAsync : string * string -> System.Threading.Tasks.Task<byte[]>

Public Function UploadFileTaskAsync (address As String, fileName As String) As Task(Of Byte())

Parameters

address

String

The URI of the resource to receive the file. For HTTP resources, this URI must identify a resource that can accept a request sent with the POST method, such as a script or ASP page.

fileName

String

The local file to send to the resource.

Returns

Task<Byte[]>

The task object representing the asynchronous operation. The Result property on the task object returns a Byte array containing the body of the response received from the resource when the file was uploaded.

Exceptions

ArgumentNullException

The address parameter is null.

-or-

The fileName parameter is null.

WebException

The URI formed by combining BaseAddress and address is invalid.

-or-

fileName is null, is Empty, contains invalid character, or the specified path to the file does not exist.

-or-

An error occurred while opening the stream.

-or-

There was no response from the server hosting the resource.

-or-

The Content-type header begins with multipart.

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 after the file has been uploaded to the resource. The file is sent asynchronously using thread resources that are automatically allocated from the thread pool.

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 (""), 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.

Note

This member outputs trace information when you enable network tracing in your application. For more information, see Network Tracing in .NET Framework.

UploadFileTaskAsync(Uri, String)

Source:

WebClient.cs

Uploads the specified local file to a resource as an asynchronous operation using a task object.

public:
 System::Threading::Tasks::Task<cli::array <System::Byte> ^> ^ UploadFileTaskAsync(Uri ^ address, System::String ^ fileName);

public System.Threading.Tasks.Task<byte[]> UploadFileTaskAsync (Uri address, string fileName);

member this.UploadFileTaskAsync : Uri * string -> System.Threading.Tasks.Task<byte[]>

Public Function UploadFileTaskAsync (address As Uri, fileName As String) As Task(Of Byte())

Parameters

address

Uri

The URI of the resource to receive the file. For HTTP resources, this URI must identify a resource that can accept a request sent with the POST method, such as a script or ASP page.

fileName

String

The local file to send to the resource.

Returns

Task<Byte[]>

The task object representing the asynchronous operation. The Result property on the task object returns a Byte array containing the body of the response received from the resource when the file was uploaded.

Exceptions

ArgumentNullException

The address parameter is null.

-or-

The fileName parameter is null.

WebException

The URI formed by combining BaseAddress and address is invalid.

-or-

fileName is null, is Empty, contains invalid character, or the specified path to the file does not exist.

-or-

An error occurred while opening the stream.

-or-

There was no response from the server hosting the resource.

-or-

The Content-type header begins with multipart.

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 after the file has been uploaded to the resource. The file is sent asynchronously using thread resources that are automatically allocated from the thread pool.

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 (""), 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.

Note

This member outputs trace information when you enable network tracing in your application. For more information, see Network Tracing in .NET Framework.