Utf8ToUnicode (String function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
Line 23: Line 23:


==Usage notes==
==Usage notes==
<ul><li><var>Utf8ToUnicode</var> is available as of <var class="product">[[Sirius Mods|Sirius Mods]]</var> Version 7.3.</ul>
<ul>
<li><var>Utf8ToUnicode</var> is available as of <var class="product">Sirius Mods</var> Version 7.3.
</ul>


==Examples==
==Examples==
In the following fragment, <var>Utf8ToUnicode</var> converts a hexadecimal input to a single <var>Unicode</var> character. In case the <var>Unicode</var> character translates to an EBCDIC character that cannot be displayed, the CharacterEncode option of <var>[[UnicodeToEbcdic (Unicode function)|UnicodeToEbcdic]]</var> causes the output of a hexadecimal character reference.
In the following fragment, <var>Utf8ToUnicode</var> converts a hexadecimal input to a single <var>Unicode</var> character. In case the <var>Unicode</var> character translates to an EBCDIC character that cannot be displayed, the <var>CharacterEncode</var> option of <var>[[UnicodeToEbcdic (Unicode function)|UnicodeToEbcdic]]</var> causes the output of a hexadecimal character reference.
<p class="code">%u unicode
<p class="code">%u unicode
%u = 'E284A2':[[X (String function)|X]]:Utf8ToUnicode
%u = 'E284A2':[[X (String function)|X]]:Utf8ToUnicode
Line 36: Line 38:


==See also==
==See also==
<ul><li><var>[[Unicode#UTF-8_and_UTF-16|Utf8 and Utf16]]</var> has more information about UTF-8 conversions.
<ul>
<li>[[Unicode#UTF-8_and_UTF-16|"Utf8 and Utf16"]] has more information about UTF-8 conversions.
<li><var>[[UnicodeToUtf8_(Unicode_function)|UnicodeToUtf8]]</var> converts a <var>Unicode</var> string to a UTF-8 <var>Longstring</var> byte stream.
<li><var>[[UnicodeToUtf8_(Unicode_function)|UnicodeToUtf8]]</var> converts a <var>Unicode</var> string to a UTF-8 <var>Longstring</var> byte stream.
<li><var>[[Utf16ToUnicode (String function)|Utf16ToUnicode]]</var> converts a UTF-16 byte stream to <var>Unicode</var>.
<li><var>[[Utf16ToUnicode (String function)|Utf16ToUnicode]]</var> converts a UTF-16 byte stream to <var>Unicode</var>.
</ul>
</ul>
{{Template:String:Utf8ToUnicode footer}}
{{Template:String:Utf8ToUnicode footer}}

Revision as of 23:10, 5 November 2012

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 Unicode 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 This argument is usable only by Sirius Software.

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

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:

&#x2122;

See also