Utf8ToUnicode (String function): Difference between revisions

Revision as of 22:44, 21 October 2010

This intrinsic function converts a UTF-8 Longstring byte stream to Unicode.

The Utf8ToUnicode function is available as of version 7.3 of the Sirius Mods.

Utf8ToUnicode syntax

  %unicode = string:Utf8ToUnicode

Syntax Terms

%unicode: A string variable to receive the method object string translated to Unicode.
string: A String or Longstring that is presumed to contain a UTF-8 byte stream.

Exceptions

This intrinsic function 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

Utf8 and Utf16 has more information about UTF-8 conversions.
The Utf16ToUnicode method converts a UTF-16 byte stream to Unicode.
The UnicodeToUtf8 method converts a Unicode string to a UTF-8 Longstring byte stream.

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 the UnicodeToEbcdic method causes the output of a hexadecimal character reference. The 'X' constant function is used in the example.

   %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;

@@ Line 2: / Line 2: @@
 The Utf8ToUnicode function is available as of version 7.3 of the [[Sirius Mods]].
 ===Utf8ToUnicode syntax===
     %unicode = string:Utf8ToUnicode
 ===Syntax Terms===
 <dl>
 <dt>%unicode
 <dd>A string variable to receive the method object string translated to Unicode.
 <dt>string
 <dd>A String or Longstring that is presumed to contain a UTF-8 byte stream.
 </dl>
@@ Line 17: / Line 17: @@
 <dl>
 <dt>[[CharacterTranslationException]]
 <dd>If the method encounters a translation problem, properties of the exception object may indicate the location and type of problem.
 </dl>
 ===Usage Notes===
 *[[Utf8 and Utf16]] has more information about UTF-8 conversions.
-*The [[Intrinsic Utf16ToUnicode Function|Utf16ToUnicode]] method converts a UTF-16 byte stream to Unicode.
+*The [[Utf16ToUnicode (String function)|Utf16ToUnicode]] method converts a UTF-16 byte stream to Unicode.
-*The [[Intrinsic UnicodeToUtf8 Function|UnicodeToUtf8]] method converts a Unicode string to a UTF-8 Longstring byte stream.
+*The [[UnicodeToUtf8 (String function)|UnicodeToUtf8]] method converts a Unicode string to a UTF-8 Longstring byte stream.
 ===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 the [[Intrinsic UnicodeToEbcdic Function|UnicodeToEbcdic]] method
+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 the [[UnicodeToEbcdic (Unicode function)|UnicodeToEbcdic]] method
-causes the output of a hexadecimal character reference. The ''''[[Intrinsic X Function|X]]'''' constant function is used in the example.
+causes the output of a hexadecimal character reference. The ''''[[X (String function)|X]]'''' constant function is used in the example.
      %u Unicode
      %u = 'E284A2':X:Utf8ToUnicode