UnicodeToUtf16 (Unicode function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
mNo edit summary
 
(33 intermediate revisions by 6 users not shown)
Line 1: Line 1:
<span style="font-size:120%; color:black"><b>Unicode string converted to UTF-16 byte stream</b></span>
{{Template:Unicode:UnicodeToUtf16 subtitle}}
[[Category:Intrinsic Unicode methods|UnicodeToUtf16 function]]
<var>UnicodeToUtf16</var> converts a <var>Unicode</var> string to a UTF-16 <var>Longstring</var> byte stream.
[[Category:Intrinsic methods]]
<!--DPL?? Category:Intrinsic Unicode methods|UnicodeToUtf16 function: Unicode string converted to UTF-16 byte stream-->
<!--DPL?? Category:Intrinsic methods|UnicodeToUtf16 (Unicode function): Unicode string converted to UTF-16 byte stream-->
<!--DPL?? Category:System methods|UnicodeToUtf16 (Unicode function): Unicode string converted to UTF-16 byte stream-->


This function converts a Unicode string to a UTF-16
==Syntax==
Longstring byte stream.
{{Template:Unicode:UnicodeToUtf16 syntax}}


The UnicodeToUtf16 function is available as of version 7.3 of the ''Sirius Mods''.
===Syntax terms===
===Syntax===
<table class="syntaxTable">
  %utf16Stream = unicode:UnicodeToUtf16([InsertBOM=bool])
<tr><th>%string</th>
====Syntax Terms====
<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>
<td>A <var>Unicode</var> string. </td></tr>
 
<tr><th><var>InsertBOM</var></th>
<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>
 
==Exceptions==
<var>UnicodeToUtf16</var> can throw the following exception:
<dl>
<dl>
<dt><i>%utf16Stream</i>
<dt><var>[[CharacterTranslationException class|CharacterTranslationException]]</var>
<dd>A String or Longstring variable to receive the method object string
<dd>If the method encounters a translation problem, properties of the exception object may indicate the location and type of problem.
translated to a UTF-16 Big-Endian byte stream
</dl>
(that is, any Unicode point U+wxyz results in the pair of bytes
 
X'wx' and X'yz', in that order).
==Usage notes==
<dt><i>unicode</i>
<dd>A Unicode string.
<dt><b>InsertBOM=</b><i>bool</i>
<dd>The optional (name required) InsertBOM argument is a Boolean:
<ul>
<ul>
<li>If its value is <tt>True</tt>, the &ldquo;Byte Order
<li><var>UnicodeToUtf16</var> is available as of <var class="product">Sirius Mods</var> Version 7.3.
Mark&rdquo; (U+FEFF) 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>
</ul>


</dl>
==Examples==
===Exceptions===
The following fragment shows a successful call of <var>UnicodeToUtf16</var>.
<p class="code">%u unicode initial('&amp;#x31;':[[U (String function)|U]])
print %u:unicodeToUtf16:[[StringToHex (String function)|stringToHex]]
print %u:unicodeToUtf16(InsertBOM=True):stringToHex
</p>
The result is:
<p class="output">0031
FEFF0031
</p>


This function can throw the following exception:
==See also==
<dl>
<dt>CharacterTranslationException
<dd>If the method encounters a translation problem,
properties of the exception object may indicate the location and type of problem.
See [[CharacterTranslationException exception class]].
</dl>
===Usage Notes===
<ul>
<ul>
<li>For more information about UTF-16 conversions, see [[Unicode#UTF-8 and UTF-16]].
<li>For more information about UTF-16 conversions, see [[Unicode#UTF-8 and UTF-16|"Unicode: UTF-8 and UTF-16"]].
<li>The [[UnicodeToUtf8 (Unicode function)|UnicodeToUtf8]] method
<li><var>[[UnicodeToUtf8 (Unicode function)|UnicodeToUtf8]]</var> converts a <var>Unicode</var> string to UTF-8.
converts a Unicode string to UTF-8.
<li><var>[[Utf16ToUnicode (String function)|Utf16ToUnicode]]</var> converts a UTF-16 <var>Longstring</var> byte stream to <var>Unicode</var>.
<li>The [[Utf16ToUnicode (String function)|Utf16ToUnicode]] method
converts a UTF-16 Longstring byte stream to Unicode.
</ul>
</ul>
===Examples===


The following fragment shows a successful call of UnicodeToUtf16.
{{Template:Unicode:UnicodeToUtf16 footer}}
The [[U (String function)|U constant function]] and [[StringToHex (String function)|StringToHex]] function
are used in the example.
<pre>
    %u Unicode Initial('&amp;#x31;':U)
    Print %u:UnicodeToUtf16:StringToHex
    Print %u:UnicodeToUtf16(InsertBOM=True):StringToHex
</pre>
The result is:
<pre>
    0031
    FEFF0031
</pre>

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:
  • If its value is True, the "Byte Order Mark" (U+FEFF) is inserted at the start of the output stream.
  • If its value is False, the default, no Byte Order Mark is inserted.

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('&#x31;':U) print %u:unicodeToUtf16:stringToHex print %u:unicodeToUtf16(InsertBOM=True):stringToHex

The result is:

0031 FEFF0031

See also

Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=UnicodeToUtf16_(Unicode_function)&oldid=12234"