UnicodeToUtf16 (Unicode function): Difference between revisions
Jump to navigation
Jump to search
m (→Syntax terms) |
mNo edit summary |
||
| (4 intermediate revisions by 2 users not shown) | |||
| Line 4: | Line 4: | ||
==Syntax== | ==Syntax== | ||
{{Template:Unicode:UnicodeToUtf16 syntax}} | {{Template:Unicode:UnicodeToUtf16 syntax}} | ||
===Syntax terms=== | ===Syntax terms=== | ||
<table class="syntaxTable"> | <table class="syntaxTable"> | ||
<tr><th>%string</th> | <tr><th>%string</th> | ||
<td>A <var>String</var> or <var>Longstring</var> variable to receive the method object string translated to a UTF-16 Big-Endian byte stream (that is, any <var>Unicode</var> point <code>U+wxyz</code> results in the pair of bytes <code>X'wx'</code> and <code>X'yz'</code>, in that order). </td></tr> | <td>A <var>String</var> or <var>Longstring</var> variable to receive the method object string translated to a UTF-16 Big-Endian byte stream (that is, any <var>Unicode</var> point <code>U+wxyz</code> results in the pair of bytes <code>X'wx'</code> and <code>X'yz'</code>, in that order). </td></tr> | ||
<tr><th>unicode</th> | <tr><th>unicode</th> | ||
<td>A <var>Unicode</var> string. </td></tr> | <td>A <var>Unicode</var> string. </td></tr> | ||
<tr><th><var>InsertBOM</var></th> | <tr><th><var>InsertBOM</var></th> | ||
<td>The optional | <td>The optional, [[Notation conventions for methods#Named parameters|name required]], <var>InsertBOM</var> argument is a <var>[[Enumerations#Using Boolean enumerations|Boolean]]</var>: | ||
<ul> | |||
<li>If its value is <code>True</code>, the "Byte Order Mark" (U+FEFF) is inserted at the start of the output stream. | |||
<li>If its value is <code>False</code>, the default, no Byte Order Mark is inserted. | |||
</ul></td></tr> | |||
</table> | </table> | ||
| Line 22: | Line 29: | ||
==Usage notes== | ==Usage notes== | ||
<ul><li><var>UnicodeToUtf16</var> is available as of <var class="product"> | <ul> | ||
<li><var>UnicodeToUtf16</var> is available as of <var class="product">Sirius Mods</var> Version 7.3. | |||
</ul> | |||
==Examples== | ==Examples== | ||
The following fragment shows a successful call of <var>UnicodeToUtf16</var>. | The following fragment shows a successful call of <var>UnicodeToUtf16</var>. | ||
<p class="code">%u unicode initial('& | <p class="code">%u unicode initial('&#x31;':[[U (String function)|U]]) | ||
print %u:unicodeToUtf16:[[StringToHex (String function)|stringToHex]] | print %u:unicodeToUtf16:[[StringToHex (String function)|stringToHex]] | ||
print %u:unicodeToUtf16(InsertBOM=True):stringToHex | print %u:unicodeToUtf16(InsertBOM=True):stringToHex | ||
| Line 34: | Line 42: | ||
<p class="output">0031 | <p class="output">0031 | ||
FEFF0031 | FEFF0031 | ||
</p | </p> | ||
==See also== | ==See also== | ||
<ul><li>For more information about UTF-16 conversions, see [[Unicode#UTF-8 and UTF-16|"Unicode: UTF-8 and UTF-16"]]. | <ul> | ||
<li>For more information about UTF-16 conversions, see [[Unicode#UTF-8 and UTF-16|"Unicode: UTF-8 and UTF-16"]]. | |||
<li><var>[[UnicodeToUtf8 (Unicode function)|UnicodeToUtf8]]</var> converts a <var>Unicode</var> string to UTF-8. | <li><var>[[UnicodeToUtf8 (Unicode function)|UnicodeToUtf8]]</var> converts a <var>Unicode</var> string to UTF-8. | ||
<li><var>[[Utf16ToUnicode (String function)|Utf16ToUnicode]]</var> converts a UTF-16 <var>Longstring</var> byte stream to <var>Unicode</var>.</ul> | <li><var>[[Utf16ToUnicode (String function)|Utf16ToUnicode]]</var> converts a UTF-16 <var>Longstring</var> byte stream to <var>Unicode</var>. | ||
</ul> | |||
{{Template:Unicode:UnicodeToUtf16 footer}} | {{Template:Unicode:UnicodeToUtf16 footer}} | ||
Latest revision as of 20:07, 6 November 2012
Translate to UTF-16 (Unicode class)
UnicodeToUtf16 converts a Unicode string to a UTF-16 Longstring byte stream.
Syntax
%string = unicode:UnicodeToUtf16[( [InsertBOM= boolean])]
Syntax terms
| %string | A String or Longstring variable to receive the method object string translated to a UTF-16 Big-Endian byte stream (that is, any Unicode point U+wxyz results in the pair of bytes X'wx' and X'yz', in that order). |
|---|---|
| unicode | A Unicode string. |
| InsertBOM | The optional, name required, InsertBOM argument is a Boolean:
|
Exceptions
UnicodeToUtf16 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
- UnicodeToUtf16 is available as of Sirius Mods Version 7.3.
Examples
The following fragment shows a successful call of UnicodeToUtf16.
%u unicode initial('1':U) print %u:unicodeToUtf16:stringToHex print %u:unicodeToUtf16(InsertBOM=True):stringToHex
The result is:
0031 FEFF0031
See also
- For more information about UTF-16 conversions, see "Unicode: UTF-8 and UTF-16".
- UnicodeToUtf8 converts a Unicode string to UTF-8.
- Utf16ToUnicode converts a UTF-16 Longstring byte stream to Unicode.