Utf16ToUnicode (String function): Difference between revisions
Jump to navigation
Jump to search
m (→Syntax terms) |
mNo edit summary |
||
| Line 25: | Line 25: | ||
==Usage notes== | ==Usage notes== | ||
<ul><li>The input UTF-16 stream may contain a Byte Order Mark (U+FEFF).<ul><li>If one is present, that controls the conversion from UTF-16 to <var>Unicode</var>.<li> If a Byte Order Mark is not present, the input stream is considered to be a Big Endian stream, that is, it is the same as if the stream were preceded by the two bytes X'FE' and X'FF', in that order.</ul> | <ul> | ||
<li>The <var>Utf16ToUnicode</var> function is available as of <var class="product"> | <li>The input UTF-16 stream may contain a Byte Order Mark (U+FEFF).<ul><li>If one is present, that controls the conversion from UTF-16 to <var>Unicode</var>.<li> If a Byte Order Mark is not present, the input stream is considered to be a Big Endian stream, that is, it is the same as if the stream were preceded by the two bytes X'FE' and X'FF', in that order.</ul> | ||
<li>The <var>Utf16ToUnicode</var> function is available as of <var class="product">Sirius Mods</var> Version 7.3. | |||
</ul> | |||
==Examples== | ==Examples== | ||
In the following fragment, <var>Utf16ToUnicode</var> converts a hexadecimal input to a single <var>Unicode</var> character | In the following fragment, <var>Utf16ToUnicode</var> converts a hexadecimal input to a single <var>Unicode</var> character: | ||
<p class="code">%u unicode | <p class="code">%u unicode | ||
%u = '0032':[[X (String function)|X]]:Utf16ToUnicode | %u = '0032':[[X (String function)|X]]:Utf16ToUnicode | ||
| Line 39: | Line 42: | ||
==See also== | ==See also== | ||
<ul><li>[[Unicode#UTF-8_and_UTF-16|UTF-8 and UTF-16]] has more information about UTF-16 conversions. | <ul> | ||
<li>The [[Utf8ToUnicode (String function)|Utf8ToUnicode]] method converts a UTF-8 byte stream to <var>Unicode</var>.</ul> | <li>[[Unicode#UTF-8_and_UTF-16|"UTF-8 and UTF-16"]] has more information about UTF-16 conversions. | ||
<li>The <var>[[Utf8ToUnicode (String function)|Utf8ToUnicode]]</var> method converts a UTF-8 byte stream to <var>Unicode</var>. | |||
</ul> | |||
{{Template:String:Utf16ToUnicode footer}} | {{Template:String:Utf16ToUnicode footer}} | ||
Revision as of 23:07, 5 November 2012
Convert a UTF-16 Longstring bytestream to Unicode (String class)
The Utf16ToUnicode intrinsic function converts a UTF-16 Longstring byte stream to Unicode.
Syntax
%unicode = string:Utf16ToUnicode[( [AllowUntranslatable= boolean], - [Bom= utf16BOM])] Throws CharacterTranslationException
Syntax terms
| %unicode | A Unicode string variable to receive the method object string translated to Unicode. |
|---|---|
| string | A string that is presumed to contain a UTF-16 byte stream. |
| AllowUntranslatable | This argument is usable only by Sirius Software. |
| BOM | This argument is usable only by Sirius Software. |
Exceptions
Utf16ToUnicode 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
- The input UTF-16 stream may contain a Byte Order Mark (U+FEFF).
- If one is present, that controls the conversion from UTF-16 to Unicode.
- If a Byte Order Mark is not present, the input stream is considered to be a Big Endian stream, that is, it is the same as if the stream were preceded by the two bytes X'FE' and X'FF', in that order.
- The Utf16ToUnicode function is available as of Sirius Mods Version 7.3.
Examples
In the following fragment, Utf16ToUnicode converts a hexadecimal input to a single Unicode character:
%u unicode %u = '0032':X:Utf16ToUnicode print %u
The result is:
2
See also
- "UTF-8 and UTF-16" has more information about UTF-16 conversions.
- The Utf8ToUnicode method converts a UTF-8 byte stream to Unicode.