UnicodeToUtf16 (Unicode function)

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])]

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

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.

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

Float class String class Unicode class	List of Float methods List of String methods List of Unicode methods List of Intrinsic methods	Float methods syntax String methods syntax Unicode methods syntax
Notation conventions for methods