Utf8ToUnicode (String function)

From m204wiki
Revision as of 09:28, 19 May 2011 by Goff (talk | contribs) (fix "using boolean enumerations" link)
Jump to navigation Jump to search

Convert a UTF-8 Longstring bytestream to Unicode (String class)

The Utf8ToUnicode intrinsic function converts a UTF-8 string to Unicode.

Syntax

%unicode = string:Utf8ToUnicode[( [AllowUntranslatable= boolean])] Throws CharacterTranslationException

Syntax terms

%unicode A string variable to receive the method object string translated to Unicode.
string The method object string that is presumed to contain a UTF-8 byte stream.
AllowUntranslatable AllowUntranslatable is an optional, but name required, parameter, which is a "Boolean Enumeration" value that specifies ....

Exceptions

Utf8ToUnicode can throw the following exception:

CharacterTranslationException
If the method encounters a translation problem, properties of the exception object may indicate the location and type of problem.

Usage notes

  • Utf8ToUnicode is available as of Sirius Mods Version 7.3.

Examples

  1. In the following fragment, Utf8ToUnicode converts a hexadecimal input to a single Unicode character. In case the Unicode character translates to an EBCDIC character that cannot be displayed, the CharacterEncode option of UnicodeToEbcdic causes the output of a hexadecimal character reference.

    %u unicode %u = 'E284A2':X:Utf8ToUnicode print %u:unicodeToEbcdic(CharacterEncode=true)

    The result of the above fragment is the character reference for the trademark character:

    ™

See also