This documentation is archived and is not being maintained.

HttpServerUtility.UrlEncode Method (String, TextWriter)

URL-encodes a string and sends the resulting output to a TextWriter output stream.

Namespace: System.Web
Assembly: System.Web (in system.web.dll)

public void UrlEncode (
	string s,
	TextWriter output
)
public void UrlEncode (
	String s, 
	TextWriter output
)
public function UrlEncode (
	s : String, 
	output : TextWriter
)

Parameters

s

The text string to encode.

output

The TextWriter output stream containing the encoded string.

URL encoding ensures that all browsers will correctly transmit text in URL strings. Characters such as ?, &, /, and spaces might be truncated or corrupted by some browsers, so those must be encoded in <a> tags or in query strings where the strings can be re-sent by a browser in a request string.

UrlEncode is a convenient way to access the System.Web.HttpUtility.UrlEncode method at run time from an ASP.NET Web application. Internally, UrlEncode uses System.Web.HttpUtility.UrlEncode to encode strings.

The following code example encodes a string for transmission by HTTP. It encodes the string named TestString, which contains the text "This is a <Test String>.", and copies it into the string named EncodedString as "This+is+a+%3cTest+String%3e.".

String TestString = "This is a <Test String>.";
StringWriter writer = new StringWriter();
Server.UrlEncode(TestString, writer);
String EncodedString = writer.ToString();
   

String testString = "This is a <Test String>.";
StringWriter writer = new StringWriter();
get_Server().UrlEncode(testString, writer);
String encodedString = writer.ToString();

var testString : String = "This is a <Test String>."
var writer : StringWriter = new StringWriter()
Server.UrlEncode(testString, writer)
var encodedString : String = writer.ToString()


Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see System Requirements.

.NET Framework

Supported in: 2.0, 1.1, 1.0
Show: