UnicodeToUtf16 (Unicode function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (1 revision) |
||
| Line 2: | Line 2: | ||
[[Category:Unicode methods|UnicodeToUtf16 function]] | [[Category:Unicode methods|UnicodeToUtf16 function]] | ||
[[Category:Intrinsic methods]] | [[Category:Intrinsic methods]] | ||
<!--DPL?? Category:Unicode methods|UnicodeToUtf16 function: Unicode string converted to UTF-16 byte stream--> | <!--DPL?? Category:Unicode methods|<var>UnicodeToUtf16</var> 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:Intrinsic methods|<var>UnicodeToUtf16</var> (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--> | <!--DPL?? Category:System methods|<var>UnicodeToUtf16</var> (Unicode function): Unicode string converted to UTF-16 byte stream--> | ||
This function converts a Unicode string to a UTF-16 | This function converts a Unicode string to a UTF-16 | ||
Longstring byte stream. | Longstring byte stream. | ||
The UnicodeToUtf16 function is available as of version 7.3 of the <var class=product>Sirius Mods</var>. | The <var>UnicodeToUtf16</var> function is available as of version 7.3 of the <var class=product>Sirius Mods</var>. | ||
==Syntax== | ==Syntax== | ||
{{Template:Unicode:UnicodeToUtf16 syntax}} | {{Template:Unicode:UnicodeToUtf16 syntax}} | ||
| Line 40: | Line 40: | ||
==Examples== | ==Examples== | ||
The following fragment shows a successful call of UnicodeToUtf16. | The following fragment shows a successful call of <var>UnicodeToUtf16</var>. | ||
The [[U (String function)|U constant function]] and [[StringToHex (String function)|StringToHex]] function | The [[U (String function)|U constant function]] and [[StringToHex (String function)|StringToHex]] function | ||
are used in the example. | are used in the example. | ||
<pre> | <pre> | ||
%u Unicode Initial('&#x31;':U) | %u Unicode Initial('&#x31;':U) | ||
Print %u:UnicodeToUtf16:StringToHex | Print %u:<var>UnicodeToUtf16</var>:StringToHex | ||
Print %u:UnicodeToUtf16(InsertBOM=True):StringToHex | Print %u:<var>UnicodeToUtf16</var>(InsertBOM=True):StringToHex | ||
</pre> | </pre> | ||
The result is: | The result is: | ||
Revision as of 15:32, 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:
|
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:<var>UnicodeToUtf16</var>:StringToHex
Print %u:<var>UnicodeToUtf16</var>(InsertBOM=True):StringToHex
The result is:
0031
FEFF0031