UnicodeToUtf8 (Unicode function)

Translate to UTF-8 (Unicode class)

UnicodeToUtf8 converts a Unicode string to a UTF-8 Longstring byte stream.

Syntax

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

Syntax terms

%string	A String or Longstring variable to receive the method object string translated to a UTF-8 byte stream.
unicode	A Unicode string.
InsertBOM	The optional (NameRequired) InsertBOM argument is a Boolean: If its value is True, the "Byte Order Mark" (U+FEFF, encoded as X'EFBBBF') is inserted at the start of the output stream. If its value is False, the default, no Byte Order Mark is inserted.

Exceptions

UnicodeToUtf8 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

• UnicodeToUtf8 is available as of Sirius Mods Version 7.3.

Examples

1. In the following fragment, UnicodeToUtf8 is used to show how the Unicode U+B2 character (superscript 2) is represented in UTF-8. Appending the StringToHex method is useful for viewing the hex values of characters that do not have displayable EBCDIC equivalents.

   %u unicode initial('²':U) print %u:UnicodeToUtf8:stringToHex

   The result is:

   C2B2

See also

• For more information about UTF-8 conversions, see "Unicode: UTF-8 and UTF-16".
• UnicodeToUtf16 converts a Unicode string to UTF-16.
• Utf8ToUnicode converts a UTF-8 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