UnicodeToUtf16 (Unicode function): Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
mNo edit summary |
||
| Line 1: | Line 1: | ||
{{Template:Unicode:UnicodeToUtf16 subtitle}} | |||
[[Category:Intrinsic Unicode methods|UnicodeToUtf16 function]] | [[Category:Intrinsic Unicode methods|UnicodeToUtf16 function]] | ||
[[Category:Intrinsic methods]] | [[Category:Intrinsic methods]] | ||
| Line 10: | Line 10: | ||
The UnicodeToUtf16 function is available as of version 7.3 of the ''Sirius Mods''. | The UnicodeToUtf16 function is available as of version 7.3 of the ''Sirius Mods''. | ||
==Syntax== | |||
{{Template:Unicode:UnicodeToUtf16 syntax}} | |||
===Syntax terms=== | |||
<dl> | <dl> | ||
<dt><i>%utf16Stream</i> | <dt><i>%utf16Stream</i> | ||
| Line 24: | Line 24: | ||
<dd>The optional (name required) InsertBOM argument is a Boolean: | <dd>The optional (name required) InsertBOM argument is a Boolean: | ||
<ul> | <ul> | ||
<li>If its value is <tt>True</tt>, the | <li>If its value is <tt>True</tt>, the "Byte Order | ||
Mark | Mark" (U+FEFF) is inserted at the start of the output | ||
stream. | stream. | ||
<li>If its value is <tt>False</tt>, the default, | <li>If its value is <tt>False</tt>, the default, | ||
| Line 41: | Line 41: | ||
See [[CharacterTranslationException exception class]]. | See [[CharacterTranslationException exception class]]. | ||
</dl> | </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]]. | ||
| Line 49: | Line 49: | ||
converts a UTF-16 Longstring byte stream to Unicode. | converts a UTF-16 Longstring byte stream to Unicode. | ||
</ul> | </ul> | ||
==Examples== | |||
The following fragment shows a successful call of UnicodeToUtf16. | The following fragment shows a successful call of UnicodeToUtf16. | ||
Revision as of 04:09, 19 January 2011
Translate to UTF-16 (Unicode class)
This function converts a Unicode string to a UTF-16 Longstring byte stream.
The UnicodeToUtf16 function is available as of version 7.3 of the Sirius Mods.
Syntax
%string = unicode:UnicodeToUtf16[( [InsertBOM= boolean])]
Syntax terms
- %utf16Stream
- 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=bool
- 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
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-16 conversions, see Unicode#UTF-8 and UTF-16.
- The UnicodeToUtf8 method converts a Unicode string to UTF-8.
- The Utf16ToUnicode method converts a UTF-16 Longstring byte stream to Unicode.
Examples
The following fragment shows a successful call of UnicodeToUtf16. The U constant function and StringToHex function are used in the example.
%u Unicode Initial('1':U)
Print %u:UnicodeToUtf16:StringToHex
Print %u:UnicodeToUtf16(InsertBOM=True):StringToHex
The result is:
0031
FEFF0031