Uri.EscapeUriString Method (System)

EscapeUriString Method

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

Uri..::.EscapeUriString Method

Converts a URI string to its escaped representation.

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

Syntax

Visual Basic (Declaration)

Public Shared Function EscapeUriString ( _
    stringToEscape As String _
) As String

Visual Basic (Usage)

Dim stringToEscape As String
Dim returnValue As String

returnValue = Uri.EscapeUriString(stringToEscape)

public static string EscapeUriString(
    string stringToEscape
)

Visual C++

public:
static String^ EscapeUriString(
    String^ stringToEscape
)

JScript

public static function EscapeUriString(
    stringToEscape : String
) : String

Parameters

stringToEscape: Type: System..::.String
The string to escape.

Return Value

Type: System..::.String
A String that contains the escaped representation of stringToEscape.

Exceptions

Exception	Condition
ArgumentNullException	stringToEscape is nullNothingnullptra null reference (Nothing in Visual Basic).
UriFormatException	The length of stringToEscape exceeds 32766 characters.

Remarks

Use the EscapeUriString method to prepare an unescaped URI string to be a parameter to the Uri constructor.

By default, the EscapeUriString method converts all characters, except RFC 2396 unreserved characters, to their hexadecimal representation. If International Resource Identifiers (IRIs) or Internationalized Domain Name (IDN) parsing is enabled, the EscapeUriString method converts all characters, except for RFC 3986 unreserved characters, to their hexadecimal representation. All Unicode characters are converted to UTF-8 format before being escaped.

This method assumes that stringToEscape has no escape sequences in it.

By default, the string is escaped according to RFC 2396. If International Resource Identifiers (IRIs) or Internationalized Domain Name (IDN) parsing is enabled, the string is escaped according to RFC 3986 and RFC 3987. See these RFCs for a definition of reserved and unreserved characters.

For more information on IRI support, see the Remarks section for the Uri class.

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, Windows CE, Windows Mobile for Smartphone, Windows Mobile for Pocket PC, Xbox 360, Zune

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

.NET Compact Framework

Supported in: 3.5, 2.0

XNA Framework

Supported in: 3.0, 2.0, 1.0

Reference

Uri Class

Uri Members

System Namespace