Translate (String function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (match syntax diagram to revised template; fix tags and links)
m (Full stop)
Line 34: Line 34:


==See also==
==See also==
<ul><li><var>Translate</var> has many similarities to the Sirius function $LSTR_TRANSLATE, which is described in the <b><i>"Sirius Functions Reference Manual"</i></b>.
<ul><li><var>Translate</var> has many similarities to the Sirius function $LSTR_TRANSLATE, which is described in the <var>[["Sirius Functions Reference Manual"]]</var>.
<li>For details of the <var>printtext</var> statement, please see <var>[[Intrinsic classes#printtext|printText]]</var></ul>
<li>For details of the <var>printtext</var> statement, please see <var>[[Intrinsic classes#printtext|printText]]</var>.</ul>
{{Template:String:Translate footer}}
{{Template:String:Translate footer}}

Revision as of 23:33, 3 February 2011

Apply a Character Map to the method object string (String class)


Translate takes a string input and outputs a copy of it in which any of the input characters that are specified in a character mapping object are replaced with the characters to which they are mapped by the object. Translate takes a CharacterMap object as input which maps In ("input table") characters to Out ("output table") characters.

Syntax

%outString = string:Translate( characterMap)

Syntax terms

%outString A string or to receive the translated input string.
string The method object input string.
characterMap A CharacterMap object variable which defines the relationship (mapping) between input and output characters.

Usage notes

Examples

  1. In the following request, a's are translated to B's, and c's are translated to d's, as dictated by the character mapping in %map:

    begin %map is object characterMap %ls is longstring %map = new(in='ac',out='Bd') %ls = 'aaaccc' printText {~} = '{%ls:translate(%map)}' end

    The result is:

    %ls:translate(%tr) = 'BBBddd'

See also