HttpUtility..::.UrlEncode Method (String)
This page is specific to:.NET Framework Version:2.03.03.54.0
.NET Framework Class Library
HttpUtility..::.UrlEncode Method (String)

Encodes a URL string.

Namespace:  System.Web
Assembly:  System.Web (in System.Web.dll)
Syntax

'Usage

Dim str As String
Dim returnValue As String

returnValue = HttpUtility.UrlEncode(str)

'Declaration

Public Shared Function UrlEncode ( _
    str As String _
) As String

Parameters

str
Type: System..::.String
The text to encode.

Return Value

Type: System..::.String
An encoded string.
Remarks

The UrlEncode()()() method can be used to encode the entire URL, including query-string values. If characters such as blanks and punctuation are passed in an HTTP stream, they might be misinterpreted at the receiving end. URL encoding converts characters that are not allowed in a URL into character-entity equivalents; URL decoding reverses the encoding. For example, when embedded in a block of text to be transmitted in a URL, the characters < and > are encoded as %3c and %3e.

You can encode a URL using with the UrlEncode()()() method or the UrlPathEncode()()() method. However, the methods return different results. The UrlEncode()()() method converts each space character to a plus character (+). The UrlPathEncode()()() method converts each space character into the string "%20", which represents a space in hexadecimal notation. Use the UrlPathEncode()()() method when you encode the path portion of a URL in order to guarantee a consistent decoded URL, regardless of which platform or browser performs the decoding.

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0, 1.1, 1.0
See Also

Reference

Other Resources

Community Content

Default Encoding
Added by:Noelle Mallory - MSFT
The documentation should reflect that the default encoding is UTF-8.
Differences from classic ASP Server.URLEncode
Added by:Cornan The Iowan
While HttpUtility.UrlEncode() is selective, Server.URLEncode() encodes as follows:
  • Spaces ( ) are converted to plus signs (+).

  • Non-alphanumeric characters are escaped to their hexadecimal representation.

The following characters are encoded by Server.URLEncode() but not by HttpUtility.UrlEncode():

!, ' (apostrophe), (, ), *, - (dash), . (period) and _ (underscore)

Also, in classic ASP Response.Cookies["cookie_name"] will encode the cookie name such that cookie_name becomes cookie%5Fname.
© 2009 Microsoft Corporation. All rights reserved.   Terms of Use | Trademarks | Privacy Statement
Page view tracker
Rate the Lightweight library
x
Lightweight builds on ScriptFree (loband) by adding features you've requested: a SearchBox and default code language selection.
Do you like the SearchBox?
Do you like the tabbed code blocks?
How useful is this topic?
Tell us more.
Thanks
x
You're helping to improve MSDN Online.
Feedback
Switch View
Classic
Lightweight Beta
ScriptFree
Switch View