WebClient.UploadFile Method

Definition

Namespace:

System.Net

Assembly:

System.Net.WebClient.dll

Uploads a local file to a resource with the specified URI.

Overloads

UploadFile(String, String)	Uploads the specified local file to a resource with the specified URI.
UploadFile(Uri, String)	Uploads the specified local file to a resource with the specified URI.
UploadFile(String, String, String)	Uploads the specified local file to the specified resource, using the specified method.
UploadFile(Uri, String, String)	Uploads the specified local file to the specified resource, using the specified method.

UploadFile(String, String)

Source:

WebClient.cs

Uploads the specified local file to a resource with the specified URI.

public:
 cli::array <System::Byte> ^ UploadFile(System::String ^ address, System::String ^ fileName);

public byte[] UploadFile (string address, string fileName);

member this.UploadFile : string * string -> byte[]

Public Function UploadFile (address As String, fileName As String) As Byte()

Parameters

address

String

The URI of the resource to receive the file. For example, ftp://localhost/samplefile.txt.

fileName

String

The file to send to the resource. For example, "samplefile.txt".

Returns

Byte[]

A Byte array containing the body of the response from the resource.

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 characters, or does not exist.

-or-

An error occurred while uploading the file.

-or-

There was no response from the server hosting the resource.

-or-

The Content-type header begins with multipart.

Examples

The following code example uploads the specified file to the specified URI using UploadFile. Any response returned by the server is displayed on the console.

Console::Write( "\nPlease enter the URI to post data to : " );
String^ uriString = Console::ReadLine();

// Create a new WebClient instance.
WebClient^ myWebClient = gcnew WebClient;
Console::WriteLine( "\nPlease enter the fully qualified path of the file to be uploaded to the URI" );
String^ fileName = Console::ReadLine();
Console::WriteLine( "Uploading {0} to {1} ...", fileName, uriString );

// Upload the file to the URI.
// The 'UploadFile(uriString, fileName)' method implicitly uses HTTP POST method.
array<Byte>^responseArray = myWebClient->UploadFile( uriString, fileName );

// Decode and display the response.
Console::WriteLine( "\nResponse Received::The contents of the file uploaded are: \n {0}", 
    System::Text::Encoding::ASCII->GetString( responseArray ) );

Console.Write("\nPlease enter the URI to post data to : ");
String uriString = Console.ReadLine();

// Create a new WebClient instance.
WebClient myWebClient = new WebClient();

Console.WriteLine("\nPlease enter the fully qualified path of the file to be uploaded to the URI");
string fileName = Console.ReadLine();
Console.WriteLine("Uploading {0} to {1} ...",fileName,uriString);

// Upload the file to the URI.
// The 'UploadFile(uriString,fileName)' method implicitly uses HTTP POST method.
byte[] responseArray = myWebClient.UploadFile(uriString,fileName);

// Decode and display the response.
Console.WriteLine("\nResponse Received. The contents of the file uploaded are:\n{0}", 
    System.Text.Encoding.ASCII.GetString(responseArray));

Console.Write(ControlChars.Cr + "Please enter the URI to post data to : ")
Dim uriString As String = Console.ReadLine()

' Create a new WebClient instance.
Dim myWebClient As New WebClient()

Console.WriteLine(ControlChars.Cr & _
    "Please enter the fully qualified path of the file to be uploaded to the URI")

Dim fileName As String = Console.ReadLine()
Console.WriteLine("Uploading {0} to {1} ...", fileName, uriString)

' Upload the file to the URI.
' The 'UploadFile(uriString,fileName)' method implicitly uses HTTP POST method. 
Dim responseArray As Byte() = myWebClient.UploadFile(uriString, fileName)

' Decode and display the response.
Console.WriteLine(ControlChars.Cr & "Response Received. The contents of the file uploaded are: " & _
    ControlChars.Cr & "{0}", System.Text.Encoding.ASCII.GetString(responseArray))

The following code example shows an ASP.NET page that can accept posted files and is suitable for use with the UploadFile method. The page must reside on a Web server. Its address provides the value for the address parameter of the UploadFile method.

<%@ Import Namespace="System"%>
<%@ Import Namespace="System.IO"%>
<%@ Import Namespace="System.Net"%>
<%@ Import NameSpace="System.Web"%>

<Script language="C#" runat=server>
void Page_Load(object sender, EventArgs e) {
    
    foreach(string f in Request.Files.AllKeys) {
        HttpPostedFile file = Request.Files[f];
        file.SaveAs("c:\\inetpub\\test\\UploadedFiles\\" + file.FileName);
    }	
}

</Script>
<html>
<body>
<p> Upload complete.  </p>
</body>
</html>

<%@ Import Namespace="System"%>
<%@ Import Namespace="System.IO"%>
<%@ Import Namespace="System.Net"%>
<%@ Import NameSpace="System.Web"%>

<Script language="VB" runat=server>
    Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs)
        
        Dim f As String
        Dim file
        For Each f In Request.Files.AllKeys
            file = Request.Files(f)
            file.SaveAs("c:\inetpub\test\UploadedFiles\" & file.FileName)
        Next f
        
    End Sub

</Script>
<html>
<body>
<p> Upload complete. </p>
</body>
</html>

Remarks

Caution

WebRequest, HttpWebRequest, ServicePoint, and WebClient are obsolete, and you shouldn't use them for new development. Use HttpClient instead.

The UploadFile method sends a local file to a resource. This method uses the STOR command to upload an FTP resource. For an HTTP resource, the POST method is used.

This method blocks while uploading the file. To continue executing while waiting for the server's response, use one of the UploadFileAsync methods.

The POST method is defined by HTTP. If the underlying request does not use HTTP and POST 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.

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.

Note

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

UploadFile(Uri, String)

Source:

WebClient.cs

Uploads the specified local file to a resource with the specified URI.

public:
 cli::array <System::Byte> ^ UploadFile(Uri ^ address, System::String ^ fileName);

public byte[] UploadFile (Uri address, string fileName);

member this.UploadFile : Uri * string -> byte[]

Public Function UploadFile (address As Uri, fileName As String) As Byte()

Parameters

address

Uri

The URI of the resource to receive the file. For example, ftp://localhost/samplefile.txt.

fileName

String

The file to send to the resource. For example, "samplefile.txt".

Returns

Byte[]

A Byte array containing the body of the response from the resource.

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 characters, or does not exist.

-or-

An error occurred while uploading the file.

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

The UploadFile method sends a local file to a resource. This method uses the STOR command to upload an FTP resource. For an HTTP resource, the POST method is used.

This method blocks while uploading the file. To continue executing while waiting for the server's response, use one of the UploadFileAsync methods.

The POST method is defined by HTTP. If the underlying request does not use HTTP and POST 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.

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.

Note

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

UploadFile(String, String, String)

Source:

WebClient.cs

Uploads the specified local file to the specified resource, using the specified method.

public:
 cli::array <System::Byte> ^ UploadFile(System::String ^ address, System::String ^ method, System::String ^ fileName);

public byte[] UploadFile (string address, string? method, string fileName);

member this.UploadFile : string * string * string -> byte[]

Public Function UploadFile (address As String, method As String, fileName As String) As Byte()

Parameters

address

String

The URI of the resource to receive the file.

method

String

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

fileName

String

The file to send to the resource.

Returns

Byte[]

A Byte array containing the body of the response from the resource.

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 characters, or does not exist.

-or-

An error occurred while uploading the file.

-or-

There was no response from the server hosting the resource.

-or-

The Content-type header begins with multipart.

Examples

The following code example uploads the specified file to the specified URI using UploadFile. Any response returned by the server is displayed on the console.

Console::Write( "\nPlease enter the URL to post data to : " );
String^ uriString = Console::ReadLine();

// Create a new WebClient instance.
WebClient^ myWebClient = gcnew WebClient;
Console::WriteLine
    ("\nPlease enter the fully qualified path of the file to be uploaded to the URL" );
String^ fileName = Console::ReadLine();
Console::WriteLine( "Uploading {0} to {1} ...", fileName, uriString );

// Upload the file to the URL using the HTTP 1.0 POST.
array<Byte>^responseArray = myWebClient->UploadFile( uriString, "POST", fileName );

// Decode and display the response.
Console::WriteLine( "\nResponse Received::The contents of the file uploaded are: \n {0}", 
    System::Text::Encoding::ASCII->GetString( responseArray ));

Console.Write("\nPlease enter the URL to post data to : ");
String uriString = Console.ReadLine();

// Create a new WebClient instance.
WebClient myWebClient = new WebClient();

Console.WriteLine("\nPlease enter the fully qualified path of the file to be uploaded to the URL");
string fileName = Console.ReadLine();

Console.WriteLine("Uploading {0} to {1} ...",fileName,uriString);						
// Upload the file to the URL using the HTTP 1.0 POST.
byte[] responseArray = myWebClient.UploadFile(uriString,"POST",fileName);

// Decode and display the response.
Console.WriteLine("\nResponse Received. The contents of the file uploaded are:\n{0}",
    System.Text.Encoding.ASCII.GetString(responseArray));

Console.Write(ControlChars.Cr + "Please enter the URL to post data to : ")
Dim uriString As String = Console.ReadLine()

' Create a new WebClient instance.
Dim myWebClient As New WebClient()
Console.WriteLine(ControlChars.Cr & _
    "Please enter the fully qualified path of the file to be uploaded to the URL")

Dim fileName As String = Console.ReadLine()
Console.WriteLine("Uploading {0} to {1} ...", fileName, uriString)

' Upload the file to the Url using the HTTP 1.0 POST.
Dim responseArray As Byte() = myWebClient.UploadFile(uriString, "POST", fileName)

' Decode and display the response.
Console.WriteLine(ControlChars.Cr + "Response Received. The contents of the file uploaded are: " & _
    ControlChars.Cr & "{0}", System.Text.Encoding.ASCII.GetString(responseArray))

The following code example shows an ASP.NET page that can accept posted files and is suitable for use with the UploadFile method. The page must reside on a Web server. Its address provides the value for the address parameter of the UploadFile method.

<%@ Import Namespace="System"%>
<%@ Import Namespace="System.IO"%>
<%@ Import Namespace="System.Net"%>
<%@ Import NameSpace="System.Web"%>

<Script language="C#" runat=server>
void Page_Load(object sender, EventArgs e) {
    
    foreach(string f in Request.Files.AllKeys) {
        HttpPostedFile file = Request.Files[f];
        file.SaveAs("c:\\inetpub\\test\\UploadedFiles\\" + file.FileName);
    }	
}

</Script>
<html>
<body>
<p> Upload complete.  </p>
</body>
</html>

<%@ Import Namespace="System"%>
<%@ Import Namespace="System.IO"%>
<%@ Import Namespace="System.Net"%>
<%@ Import NameSpace="System.Web"%>

<Script language="VB" runat=server>
    Sub Page_Load(ByVal sender As Object, ByVal e As EventArgs)
        
        Dim f As String
        Dim file
        For Each f In Request.Files.AllKeys
            file = Request.Files(f)
            file.SaveAs("c:\inetpub\test\UploadedFiles\" & file.FileName)
        Next f
        
    End Sub

</Script>
<html>
<body>
<p> Upload complete. </p>
</body>
</html>

Remarks

Caution

WebRequest, HttpWebRequest, ServicePoint, and WebClient are obsolete, and you shouldn't use them for new development. Use HttpClient instead.

When address specifies an HTTP resource, the UploadFile method sends a local file to a resource using the HTTP method specified in the method parameter and returns any response from the server. This method blocks while uploading the file. To continue executing while waiting for the server's response, use one of the UploadFileAsync methods.

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

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.

Note

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

UploadFile(Uri, String, String)

Source:

WebClient.cs

Uploads the specified local file to the specified resource, using the specified method.

public:
 cli::array <System::Byte> ^ UploadFile(Uri ^ address, System::String ^ method, System::String ^ fileName);

public byte[] UploadFile (Uri address, string? method, string fileName);

member this.UploadFile : Uri * string * string -> byte[]

Public Function UploadFile (address As Uri, method As String, fileName As String) As Byte()

Parameters

address

Uri

The URI of the resource to receive the file.

method

String

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

fileName

String

The file to send to the resource.

Returns

Byte[]

A Byte array containing the body of the response from the resource.

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 characters, or does not exist.

-or-

An error occurred while uploading the file.

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

When address specifies an HTTP resource, the UploadFile method sends a local file to a resource using the HTTP method specified in the method parameter and returns any response from the server. This method blocks while uploading the file. To continue executing while waiting for the server's response, use one of the UploadFileAsync methods.

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

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.

Note

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