Utf8ToUnicode (String function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (fix "using boolean enumerations" link)
Line 11: Line 11:
<td>The method object <var class="term">string</var> that is presumed to contain a UTF-8 byte stream.</td></tr>
<td>The method object <var class="term">string</var> that is presumed to contain a UTF-8 byte stream.</td></tr>
<tr><th><var>AllowUntranslatable</var></th>
<tr><th><var>AllowUntranslatable</var></th>
<td><var>AllowUntranslatable</var> is an optional, but [[Methods#Named parameters|name required]], parameter, which is a <var>[[Boolean Enumeration]]</var> value that specifies ....</td></tr>
<td><var>AllowUntranslatable</var> is an optional, but [[Methods#Named parameters|name required]], parameter, which is a [[Enumerations#Using_Boolean_enumerations|"Boolean Enumeration"]] value that specifies ....</td></tr>
</table>
</table>



Revision as of 09:28, 19 May 2011

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:

    &amp;amp;amp;#x2122;

See also