WebClient.UploadValues Method

Definition

Uploads a name/value collection to a resource with the specified URI.

Overloads

UploadValues(String, NameValueCollection)

Uploads the specified name/value collection to the resource identified by the specified URI.

UploadValues(Uri, NameValueCollection)

Uploads the specified name/value collection to the resource identified by the specified URI.

UploadValues(String, String, NameValueCollection)

Uploads the specified name/value collection to the resource identified by the specified URI, using the specified method.

UploadValues(Uri, String, NameValueCollection)

Uploads the specified name/value collection to the resource identified by the specified URI, using the specified method.

UploadValues(String, NameValueCollection)

Source:
WebClient.cs
Source:
WebClient.cs
Source:
WebClient.cs

Uploads the specified name/value collection to the resource identified by the specified URI.

C#
public byte[] UploadValues(string address, System.Collections.Specialized.NameValueCollection data);

Parameters

address
String

The URI of the resource to receive the collection.

data
NameValueCollection

The NameValueCollection to send to the resource.

Returns

Byte[]

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

Exceptions

The address parameter is null.

-or-

The data parameter is null.

The URI formed by combining BaseAddress, and address is invalid.

-or-

data is null.

-or-

There was no response from the server hosting the resource.

-or-

An error occurred while opening the stream.

-or-

The Content-type header is not null or "application/x-www-form-urlencoded".

Examples

The following code example gathers information from the user (name, age, and address) and posts the values to the server using UploadValues. Any response from the server is displayed on the console.

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

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

// Create a new NameValueCollection instance to hold some custom parameters to be posted to the URL.
NameValueCollection myNameValueCollection = new NameValueCollection();

Console.WriteLine("Please enter the following parameters to be posted to the URL");
Console.Write("Name:");
string name = Console.ReadLine();

Console.Write("Age:");
string age = Console.ReadLine();

Console.Write("Address:");
string address = Console.ReadLine();

// Add necessary parameter/value pairs to the name/value container.
myNameValueCollection.Add("Name",name);            
myNameValueCollection.Add("Address",address);
myNameValueCollection.Add("Age",age);

Console.WriteLine("\nUploading to {0} ...",  uriString);
// 'The Upload(String,NameValueCollection)' implicitly method sets HTTP POST as the request method.            
byte[] responseArray = myWebClient.UploadValues(uriString,myNameValueCollection);

// Decode and display the response.
Console.WriteLine("\nResponse received was :\n{0}",Encoding.ASCII.GetString(responseArray));

Remarks

Caution

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

The UploadValues method sends a NameValueCollection to a server. This method blocks while uploading the data. To continue executing while waiting for the server's response, use one of the UploadValuesAsync methods.

If the underlying request 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 Content-type header is null, the UploadValues method sets it to "application/x-www-form-urlencoded".

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.

Note

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

Applies to

.NET 9 and other versions
Product Versions
.NET Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 2.0, 2.1

UploadValues(Uri, NameValueCollection)

Source:
WebClient.cs
Source:
WebClient.cs
Source:
WebClient.cs

Uploads the specified name/value collection to the resource identified by the specified URI.

C#
public byte[] UploadValues(Uri address, System.Collections.Specialized.NameValueCollection data);

Parameters

address
Uri

The URI of the resource to receive the collection.

data
NameValueCollection

The NameValueCollection to send to the resource.

Returns

Byte[]

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

Exceptions

The address parameter is null.

-or-

The data parameter is null.

The URI formed by combining BaseAddress, and address is invalid.

-or-

data is null.

-or-

There was no response from the server hosting the resource.

-or-

An error occurred while opening the stream.

-or-

The Content-type header is not null or "application/x-www-form-urlencoded".

Remarks

Caution

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

The UploadValues method sends a NameValueCollection to a server. This method blocks while uploading the data. To continue executing while waiting for the server's response, use one of the UploadValuesAsync methods.

If the underlying request 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 Content-type header is null, the UploadValues method sets it to "application/x-www-form-urlencoded".

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.

Note

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

Applies to

.NET 9 and other versions
Product Versions
.NET Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 2.0, 2.1

UploadValues(String, String, NameValueCollection)

Source:
WebClient.cs
Source:
WebClient.cs
Source:
WebClient.cs

Uploads the specified name/value collection to the resource identified by the specified URI, using the specified method.

C#
public byte[] UploadValues(string address, string? method, System.Collections.Specialized.NameValueCollection data);
C#
public byte[] UploadValues(string address, string method, System.Collections.Specialized.NameValueCollection data);

Parameters

address
String

The URI of the resource to receive the collection.

method
String

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

data
NameValueCollection

The NameValueCollection to send to the resource.

Returns

Byte[]

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

Exceptions

The address parameter is null.

-or-

The data parameter is null.

The URI formed by combining BaseAddress, and address is invalid.

-or-

data is null.

-or-

An error occurred while opening the stream.

-or-

There was no response from the server hosting the resource.

-or-

The Content-type header value is not null and is not application/x-www-form-urlencoded.

Examples

The following code example gathers information from the user (name, age, and address) and posts the values to the server using UploadValues. Any response from the server is displayed on the console.

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

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

// Create a new NameValueCollection instance to hold some custom parameters to be posted to the URL.
NameValueCollection myNameValueCollection = new NameValueCollection();

Console.WriteLine("Please enter the following parameters to be posted to the URI");
Console.Write("Name:");
string name = Console.ReadLine();

Console.Write("Age:");
string age = Console.ReadLine();

Console.Write("Address:");
string address = Console.ReadLine();

// Add necessary parameter/value pairs to the name/value container.
myNameValueCollection.Add("Name",name);			
myNameValueCollection.Add("Address",address);
myNameValueCollection.Add("Age",age);
Console.WriteLine("\nUploading to {0} ...",  uriString);

// Upload the NameValueCollection.
byte[] responseArray = myWebClient.UploadValues(uriString,"POST",myNameValueCollection);

// Decode and display the response.
Console.WriteLine("\nResponse received was :\n{0}",Encoding.ASCII.GetString(responseArray));

Remarks

Caution

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

The UploadValues method sends a NameValueCollection to a resource using the method specified in the method parameter and returns any response from the server. This method blocks while uploading the data. To continue executing while waiting for the server's response, use one of the UploadValuesAsync methods.

If the Content-type header is null, the UploadValues method sets it to application/x-www-form-urlencoded.

If the method parameter specifies a verb 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.

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.

Applies to

.NET 9 and other versions
Product Versions
.NET Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 2.0, 2.1

UploadValues(Uri, String, NameValueCollection)

Source:
WebClient.cs
Source:
WebClient.cs
Source:
WebClient.cs

Uploads the specified name/value collection to the resource identified by the specified URI, using the specified method.

C#
public byte[] UploadValues(Uri address, string? method, System.Collections.Specialized.NameValueCollection data);
C#
public byte[] UploadValues(Uri address, string method, System.Collections.Specialized.NameValueCollection data);

Parameters

address
Uri

The URI of the resource to receive the collection.

method
String

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

data
NameValueCollection

The NameValueCollection to send to the resource.

Returns

Byte[]

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

Exceptions

The address parameter is null.

-or-

The data parameter is null.

The URI formed by combining BaseAddress, and address is invalid.

-or-

data is null.

-or-

An error occurred while opening the stream.

-or-

There was no response from the server hosting the resource.

-or-

The Content-type header value is not null and is not application/x-www-form-urlencoded.

Remarks

Caution

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

The UploadValues method sends a NameValueCollection to a resource using the method specified in the method parameter and returns any response from the server. This method blocks while uploading the data. To continue executing while waiting for the server's response, use one of the UploadValuesAsync methods.

If the Content-type header is null, the UploadValues method sets it to application/x-www-form-urlencoded.

If the method parameter specifies a verb 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.

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.

Applies to

.NET 9 and other versions
Product Versions
.NET Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 2.0, 2.1