Export (0) Print
Expand All

WebClient.UploadFileTaskAsync Method (String, String, String)

.NET Framework 4.5

Uploads the specified local file to a 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<byte[]> UploadFileTaskAsync(
	string address,
	string method,
	string fileName
)

Parameters

address
Type: System.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
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.

fileName
Type: System.String

The local file to send to the resource.

Return Value

Type: System.Threading.Tasks.Task<Byte[]>
Returns Task<TResult>.
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.

ExceptionCondition
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.

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.

Asynchronous operations that have not completed can be canceled using 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.

NoteNote

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

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.

Show:
© 2014 Microsoft