UnicodeToUtf8 (Unicode function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
mNo edit summary |
||
| (35 intermediate revisions by 7 users not shown) | |||
| Line 1: | Line 1: | ||
{{Template:Unicode:UnicodeToUtf8 subtitle}} | |||
<var>UnicodeToUtf8</var> converts a <var>Unicode</var> string to a UTF-8 <var>Longstring</var> byte stream. | |||
< | |||
< | |||
==Syntax== | |||
{{Template:Unicode:UnicodeToUtf8 syntax}} | |||
===Syntax terms=== | |||
<table class="syntaxTable"> | |||
===Syntax=== | <tr><th>%string</th> | ||
<td>A <var>String</var> or <var>Longstring</var> variable to receive the method object string translated to a UTF-8 byte stream.</td></tr> | |||
<tr><th>unicode</th> | |||
< | <td>A <var>Unicode</var> string.</td></tr> | ||
< | <tr><th><var>InsertBOM</var></th> | ||
translated to a UTF-8 byte stream. | <td>The optional, [[Notation conventions for methods#Named parameters|name required]], <var>InsertBOM</var> argument is a [[Boolean enumeration|Boolean]]: | ||
< | |||
< | |||
< | |||
< | |||
<ul> | <ul> | ||
<li>If its value is < | <li>If its value is <code>True</code>, the "Byte Order Mark" (U+FEFF, encoded as X'EFBBBF') is inserted at the start of the output stream. | ||
Mark | <li>If its value is <code>False</code>, the default, no Byte Order Mark is inserted. | ||
stream. | </ul></td></tr> | ||
<li>If its value is < | </table> | ||
no Byte Order Mark is inserted. | |||
</ul> | |||
===Exceptions=== | ===Exceptions=== | ||
<var>UnicodeToUtf8</var> can throw the following exception: | |||
<dl> | <dl> | ||
<dt>CharacterTranslationException | <dt><var>[[CharacterTranslationException class|CharacterTranslationException]]</var> | ||
<dd>If the method encounters a translation problem, | <dd>If the method encounters a translation problem, properties of the exception object may indicate the location and type of problem. | ||
properties of the exception object may indicate the location and type of problem | |||
</dl> | </dl> | ||
==Usage notes== | |||
<ul> | <ul> | ||
<li> | <li><var>UnicodeToUtf8</var> is available as of <var class="product">Sirius Mods</var> Version 7.3. | ||
< | |||
</ul> | </ul> | ||
In the following fragment, UnicodeToUtf8 is used to show how the | ==Examples== | ||
Unicode U+B2 character (superscript 2) is represented in UTF-8. | In the following fragment, <var>UnicodeToUtf8</var> is used to show how the <var>Unicode</var> U+B2 character (superscript 2) is represented in UTF-8. Appending the <var>StringToHex</var> method is useful for viewing the hex values of characters that do not have displayable EBCDIC equivalents. | ||
Appending the StringToHex method is useful for viewing | <p class="code">%u unicode initial('&#xB2;':[[U (String function)|U]]) | ||
the hex values of characters that do not have displayable EBCDIC equivalents. | print %u:UnicodeToUtf8:[[StringToHex (String function)|stringToHex]] | ||
</p> | |||
The result is: | |||
<p class="output">C2B2 | |||
</p> | |||
==See also== | |||
<ul><li>For more information about UTF-8 conversions, see [[Unicode#UTF-8 and UTF-16|"Unicode: UTF-8 and UTF-16"]]. | |||
< | <li><var>[[UnicodeToUtf16 (Unicode function)|UnicodeToUtf16]]</var> converts a <var>Unicode</var> string to UTF-16. | ||
<li><var>[[Utf8ToUnicode (String function)|Utf8ToUnicode]]</var> converts a UTF-8 <var>Longstring</var> byte stream to <var>Unicode</var>. | |||
</ul> | |||
</ | {{Template:Unicode:UnicodeToUtf8 footer}} | ||
< | |||
</ | |||
Latest revision as of 20:10, 6 November 2012
Translate to UTF-8 (Unicode class)
UnicodeToUtf8 converts a Unicode string to a UTF-8 Longstring byte stream.
Syntax
%string = unicode:UnicodeToUtf8[( [InsertBOM= boolean])]
Syntax terms
| %string | A String or Longstring variable to receive the method object string translated to a UTF-8 byte stream. |
|---|---|
| unicode | A Unicode string. |
| InsertBOM | The optional, name required, InsertBOM argument is a Boolean:
|
Exceptions
UnicodeToUtf8 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
- UnicodeToUtf8 is available as of Sirius Mods Version 7.3.
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.
%u unicode initial('²':U) print %u:UnicodeToUtf8:stringToHex
The result is:
C2B2
See also
- For more information about UTF-8 conversions, see "Unicode: UTF-8 and UTF-16".
- UnicodeToUtf16 converts a Unicode string to UTF-16.
- Utf8ToUnicode converts a UTF-8 Longstring byte stream to Unicode.