EscapeDataString Method

Uri.EscapeDataString Method (String)

 

Converts a string to its escaped representation.

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

public static string EscapeDataString(
	string stringToEscape
)

Parameters

stringToEscape
Type: System.String

The string to escape.

Return Value

Type: System.String

A String that contains the escaped representation of stringToEscape.

Exception Condition
ArgumentNullException

stringToEscape is null.

UriFormatException
System_CAPS_noteNote

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.

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.

Universal Windows Platform
Available since 4.5
.NET Framework
Available since 2.0
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 2.0
Windows Phone Silverlight
Available since 7.0
Windows Phone
Available since 8.1
Return to top
Show:
© 2016 Microsoft