WebClient.UploadValues Method (String, NameValueCollection)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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

Namespace:   System.Net
Assembly:  System (in System.dll)

Public Function UploadValues (
	address As String,
	data As NameValueCollection
) As Byte()

Parameters

address
Type: System.String

The URI of the resource to receive the collection.

data
Type: System.Collections.Specialized.NameValueCollection

The NameValueCollection to send to the resource.

Return Value

Type: System.Byte()

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

Exception Condition
ArgumentNullException

The address parameter is null.

-or-

The data parameter is null.

WebException

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

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.

System_CAPS_noteNote

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

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.

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()
' Create a new NameValueCollection instance to hold some custom parameters to be posted to the URL.
Dim myNameValueCollection As New NameValueCollection()
Console.WriteLine("Please enter the following parameters to be posted to the URL:")
Console.Write("Name:")
Dim name As String = Console.ReadLine()

Console.Write("Age:")
Dim age As String = Console.ReadLine()

Console.Write("Address:")
Dim address As String = 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(ControlChars.Cr + "Uploading to {0} ...", uriString)
' The Upload(String,NameValueCollection)' method implicitly sets the HTTP POST as the request method.			
Dim responseArray As Byte() = myWebClient.UploadValues(uriString, myNameValueCollection)

' Decode and display the response.
Console.WriteLine(ControlChars.Cr + "Response received was :" + ControlChars.Cr + "{0}", Encoding.ASCII.GetString(responseArray))

.NET Framework
Available since 1.1
Return to top
Show: