URI.uriEscapeString

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.

struct URI
static
string
uriEscapeString

Parameters

unescaped string

the unescaped input string.

reservedCharsAllowed string

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

allowUtf8 bool

%TRUE if the result can include UTF-8 characters.

Return Value

Type: string

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

Meta

Since

2.16