Uri.EscapeUriString(String) Method

Definition

Caution

Uri.EscapeUriString can corrupt the Uri string in some cases. Consider using Uri.EscapeDataString for query string components instead.

Converts a URI string to its escaped representation.

public:
 static System::String ^ EscapeUriString(System::String ^ stringToEscape);
public static string EscapeUriString (string stringToEscape);
[System.Obsolete("Uri.EscapeUriString can corrupt the Uri string in some cases. Consider using Uri.EscapeDataString for query string components instead.", DiagnosticId="SYSLIB0013", UrlFormat="https://aka.ms/dotnet-warnings/{0}")]
public static string EscapeUriString (string stringToEscape);
static member EscapeUriString : string -> string
[<System.Obsolete("Uri.EscapeUriString can corrupt the Uri string in some cases. Consider using Uri.EscapeDataString for query string components instead.", DiagnosticId="SYSLIB0013", UrlFormat="https://aka.ms/dotnet-warnings/{0}")>]
static member EscapeUriString : string -> string
Public Shared Function EscapeUriString (stringToEscape As String) As String

Parameters

stringToEscape
String

The string to escape.

Returns

String

The escaped representation of stringToEscape.

Attributes

Exceptions

stringToEscape is null.

Note: In the .NET for Windows Store apps or the Portable Class Library, catch the base class exception, FormatException, instead.

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.

Applies to