escapeString

fun escapeString(unescaped: String, reservedCharsAllowed: String? = null, allowUtf8: Boolean): String

Escapes a string for use in a URI.

Normally all characters that are not "unreserved" (i.e. ASCII alphanumerical characters plus dash, dot, underscore and tilde) are escaped. But if you specify characters in @reserved_chars_allowed they are not escaped. This is useful for the "reserved" characters in the URI specification, since those are allowed unescaped in some portions of a URI.

Return

an escaped version of @unescaped. The returned string should be freed when no longer needed.

Since

2.16

Parameters

unescaped

the unescaped input string.

reservedCharsAllowed

a string of reserved characters that are allowed to be used, or null.

allowUtf8

true if the result can include UTF-8 characters.