%SYN_UNESCAPE_HANDLE

Unescape escape codes in a string in a handle

WSupported on Windows
USupported on Unix
VSupported on OpenVMS
NSupported in Synergy .NET
status = %SYN_UNESCAPE_HANDLE(handle, rules, length)

Return value

status

Always returns 0.

Arguments

handle

The memory handle that contains the string to unescape. (D_HANDLE)

rules

The unescape rules to use:

XML_RULES = Use XML unescape rules.

HTTP_RULES = Use HTTP unescape rules.

HTTP_DATARULES = Use HTTP unescape rules.

length

The length of the string and, upon return, the length of the unescaped text. (n)

Discussion

%SYN_UNESCAPE_HANDLE enables you to unescape escape codes in a string within a memory handle. See %SYN_ESCAPE_HANDLE for a list of escape codes and their corresponding characters.

%SYN_UNESCAPE_HANDLE can also unescape a character in XML decimal or hexadecimal escape code format to its corresponding ASCII character representation. For example, it will unescape (decimal) or (hexadecimal) to a space character.

Examples

See %SYN_ESCAPE_HANDLE Examples.