UnicodeToUtf16 (Unicode function)

Translate to UTF-16 (Unicode class)

UnicodeToUtf16 converts a Unicode string to a UTF-16 Longstring byte stream.

Syntax

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

Syntax terms

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

UnicodeToUtf16 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

• UnicodeToUtf16 is available as of Sirius Mods Version 7.3.

Examples

The following fragment shows a successful call of UnicodeToUtf16.

%u unicode initial('1':U) print %u:unicodeToUtf16:stringToHex print %u:unicodeToUtf16(InsertBOM=True):stringToHex

The result is:

0031 FEFF0031

See also

• For more information about UTF-16 conversions, see "Unicode: UTF-8 and UTF-16".
• UnicodeToUtf8 converts a Unicode string to UTF-8.
• Utf16ToUnicode converts a UTF-16 Longstring byte stream to Unicode.

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