UnicodeToUtf8 (Unicode function): Difference between revisions
Jump to navigation
Jump to search
m (1 revision) |
m (1 revision) |
||
| Line 2: | Line 2: | ||
[[Category:Unicode methods|UnicodeToUtf8 function]] | [[Category:Unicode methods|UnicodeToUtf8 function]] | ||
[[Category:Intrinsic methods]] | [[Category:Intrinsic methods]] | ||
<!--DPL?? Category:Unicode methods|UnicodeToUtf8 function: Unicode string converted to UTF-8 byte stream--> | <!--DPL?? Category:Unicode methods|<var>UnicodeToUtf8</var> function: Unicode string converted to UTF-8 byte stream--> | ||
<!--DPL?? Category:Intrinsic methods|UnicodeToUtf8 (Unicode function): Unicode string converted to UTF-8 byte stream--> | <!--DPL?? Category:Intrinsic methods|<var>UnicodeToUtf8</var> (Unicode function): Unicode string converted to UTF-8 byte stream--> | ||
<!--DPL?? Category:System methods|UnicodeToUtf8 (Unicode function): Unicode string converted to UTF-8 byte stream--> | <!--DPL?? Category:System methods|<var>UnicodeToUtf8</var> (Unicode function): Unicode string converted to UTF-8 byte stream--> | ||
This function converts a Unicode string to a UTF-8 | This function converts a Unicode string to a UTF-8 | ||
Longstring byte stream. | Longstring byte stream. | ||
The UnicodeToUtf8 function is available as of version 7.3 of the <var class=product>Sirius Mods</var>. | The <var>UnicodeToUtf8</var> function is available as of version 7.3 of the <var class=product>Sirius Mods</var>. | ||
==Syntax== | ==Syntax== | ||
{{Template:Unicode:UnicodeToUtf8 syntax}} | {{Template:Unicode:UnicodeToUtf8 syntax}} | ||
| Line 41: | Line 41: | ||
==Examples== | ==Examples== | ||
In the following fragment, UnicodeToUtf8 is used to show how the | In the following fragment, <var>UnicodeToUtf8</var> is used to show how the | ||
Unicode U+B2 character (superscript 2) is represented in UTF-8. | Unicode U+B2 character (superscript 2) is represented in UTF-8. | ||
Appending the StringToHex method is useful for viewing | Appending the StringToHex method is useful for viewing | ||
| Line 50: | Line 50: | ||
<pre> | <pre> | ||
%u Unicode Initial('&#xB2;':U) | %u Unicode Initial('&#xB2;':U) | ||
Print %u:UnicodeToUtf8:StringToHex | Print %u:<var>UnicodeToUtf8</var>:StringToHex | ||
</pre> | </pre> | ||
Revision as of 15:32, 19 January 2011
Translate to UTF-8 (Unicode class)
This function converts a Unicode string to a UTF-8 Longstring byte stream.
The UnicodeToUtf8 function is available as of version 7.3 of the Sirius Mods.
Syntax
%string = unicode:UnicodeToUtf8[( [InsertBOM= boolean])]
Syntax terms
| %utf8Stream | A String or Longstring variable to receive the method object string translated to a UTF-8 byte stream. |
|---|---|
| unicode | A Unicode string. |
| InsertBOM=bool | The optional (name required) InsertBOM argument is a Boolean:
|
Exceptions
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.
Usage notes
- For more information about UTF-8 conversions, see Unicode#UTF-8 and UTF-16.
- The UnicodeToUtf16 method converts a Unicode string to UTF-16.
- The Utf8ToUnicode method converts a UTF-8 Longstring byte stream to Unicode.
Examples
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.
The U constant function and StringToHex function are used in the example.
%u Unicode Initial('²':U)
Print %u:<var>UnicodeToUtf8</var>:StringToHex
The result is:
C2B2