UnicodeToUtf8 (Unicode function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (1 revision) |
||
| Line 14: | Line 14: | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th><i>%utf8Stream</i> </th> | <tr><th><i>%utf8Stream</i></th> | ||
<td>A String or Longstring variable to receive the method object string translated to a UTF-8 byte stream. </td></tr> | <td>A String or Longstring variable to receive the method object string translated to a UTF-8 byte stream. </td></tr> | ||
<tr><th><i>unicode</i> </th> | <tr><th><i>unicode</i></th> | ||
<td>A Unicode string. </td></tr> | <td>A Unicode string. </td></tr> | ||
<tr><th><b>InsertBOM=</b><i>bool</i> </th> | <tr><th><b>InsertBOM=</b><i>bool</i></th> | ||
<td>The optional (name required) InsertBOM argument is a Boolean: <ul> <li>If its value is <tt>True</tt>, the "Byte Order Mark" (U+FEFF, encoded as X'EFBBBF') is inserted at the start of the output stream. <li>If its value is <tt>False</tt>, the default, no Byte Order Mark is inserted. </ul></td></tr> | <td>The optional (name required) InsertBOM argument is a Boolean: <ul> <li>If its value is <tt>True</tt>, the "Byte Order Mark" (U+FEFF, encoded as X'EFBBBF') is inserted at the start of the output stream. <li>If its value is <tt>False</tt>, the default, no Byte Order Mark is inserted. </ul></td></tr> | ||
</table> | </table> | ||
Revision as of 15:49, 19 January 2011
Translate to UTF-8 (Unicode class)
This function converts a Unicode string to a UTF-8 Longstring byte stream.
The UnicodeToUtf8 function is available as of version 7.3 of the Sirius Mods.
Syntax
%string = unicode:UnicodeToUtf8[( [InsertBOM= boolean])]
Syntax terms
| %utf8Stream | A String or Longstring variable to receive the method object string translated to a UTF-8 byte stream. |
|---|---|
| unicode | A Unicode string. |
| InsertBOM=bool | The optional (name required) InsertBOM argument is a Boolean:
|
Exceptions
This 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. See CharacterTranslationException exception class.
Usage notes
- For more information about UTF-8 conversions, see Unicode#UTF-8 and UTF-16.
- The UnicodeToUtf16 method converts a Unicode string to UTF-16.
- The Utf8ToUnicode method converts a UTF-8 Longstring byte stream to Unicode.
Examples
In the following fragment, UnicodeToUtf8 is used to show how the Unicode U+B2 character (superscript 2) is represented in UTF-8. Appending the StringToHex method is useful for viewing the hex values of characters that do not have displayable EBCDIC equivalents.
The U constant function and StringToHex function are used in the example.
%u Unicode Initial('²':U)
Print %u:<var>UnicodeToUtf8</var>:StringToHex
The result is:
C2B2