UnicodeToUtf16 (Unicode function): Difference between revisions

Revision as of 14:23, 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.

%string = unicode:UnicodeToUtf16[( [InsertBOM= boolean])]

%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.

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.

The following fragment shows a successful call of UnicodeToUtf16. The U constant function and StringToHex function are used in the example.

    %u Unicode Initial('&#x31;':U)
    Print %u:UnicodeToUtf16:StringToHex
    Print %u:UnicodeToUtf16(InsertBOM=True):StringToHex

The result is:

    0031
    FEFF0031

@@ Line 1: / Line 1: @@
 {{Template:Unicode:UnicodeToUtf16 subtitle}}
-[[Category:Intrinsic Unicode methods|UnicodeToUtf16 function]]
+[[Category:Unicode methods|UnicodeToUtf16 function]]
 [[Category:Intrinsic methods]]
-<!--DPL?? Category:Intrinsic Unicode methods|UnicodeToUtf16 function: Unicode string converted to UTF-16 byte stream-->
+<!--DPL?? Category: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-->