CharacterToUnicode (String function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
Line 22: Line 22:


==Examples==
==Examples==
See the [[CharacterToUnicodeMap class#Example|CharacterToUnicodeMap class example]].


==See also==
==See also==
{{Template:String:CharacterToUnicode footer}}
{{Template:String:CharacterToUnicode footer}}

Revision as of 17:10, 2 December 2011

Translate characters to unicode (String class)

[Introduced in Sirius Mods 8.0]


CharacterToUnicode takes a string input and outputs a copy of it in which any of the input characters that are also specified in a CharacterToUnicodeMap object are replaced with the characters to which they are mapped by the object. A CharacterToUnicodeMap object maps code points in a character set to corresponding Unicode characters.

Syntax

%unicode = string:CharacterToUnicode( characterToUnicodeMap) Throws CharacterTranslationException

Syntax terms

%unicode A Unicode string variable to receive the Unicode character mapped to the method object string.
string A string of characters to be individually converted to the Unicode characters to which they are mapped in the characterToUnicodeMap object.
characterToUnicodeMap A CharacterToUnicodeMap object.

Usage notes

  • If the string method object contains a character that is not present in characterToUnicodeMap, a CharacterTranslationException exception is returned.

Examples

See the CharacterToUnicodeMap class example.

See also