Uri.EscapeDataString(String) Uri.EscapeDataString(String) Uri.EscapeDataString(String) Uri.EscapeDataString(String) Method

Definition

Converts a string to its escaped representation.

public:
 static System::String ^ EscapeDataString(System::String ^ stringToEscape);
public static string EscapeDataString (string stringToEscape);
static member EscapeDataString : string -> string
Public Shared Function EscapeDataString (stringToEscape As String) As String

Parameters

stringToEscape
String String String String

The string to escape.

Returns

A String that contains the escaped representation of stringToEscape.

Exceptions

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

By default, the EscapeDataString method converts all characters except for RFC 2396 unreserved characters to their hexadecimal representation. If International Resource Identifiers (IRIs) or Internationalized Domain Name (IDN) parsing is enabled, the EscapeDataString 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