Translate (String function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
m (1 revision)
m (1 revision)
Line 7: Line 7:
<var>Translate</var> has many similarities to the Sirius function $LSTR_TRANSLATE, which is described in the '''''Sirius Functions Reference Manual'''''.
<var>Translate</var> has many similarities to the Sirius function $LSTR_TRANSLATE, which is described in the '''''Sirius Functions Reference Manual'''''.


The <var>Translate</var> method takes a CharacterMap object as input. A [[aracterMap class|CharacterMap]] object maps In ("input table")
The <var>Translate</var> method takes a <var>CharacterMap</var> object as input. A [[aracterMap class|CharacterMap]] object maps In ("input table")
characters to Out ("output table") characters.
characters to Out ("output table") characters.
==Syntax==
==Syntax==
Line 14: Line 14:
<table class="syntaxTable">
<table class="syntaxTable">
<tr><th>%outStr</th>
<tr><th>%outStr</th>
<td>A string or Longstring to receive the translated input string.                                </td></tr>
<td>A string or <var>Longstring</var> to receive the translated input string.                                </td></tr>
<tr><th>string</th>
<tr><th>string</th>
<td>The input string or Longstring.                                                              </td></tr>
<td>The input string or <var>Longstring</var>.                                                              </td></tr>
<tr><th>charMap</th>
<tr><th>charMap</th>
<td>A CharacterMap object variable which indicates the output characters to which specified input characters are to be mapped.</td></tr>
<td>A <var>CharacterMap</var> object variable which indicates the output characters to which specified input characters are to be mapped.</td></tr>
</table>
</table>


==Usage notes==
==Usage notes==
*For information about constructing a CharacterMap object, see [[CharacterMap New constructor]].
*For information about constructing a <var>CharacterMap</var> object, see [[CharacterMap New constructor]].
==Examples==
==Examples==



Revision as of 15:48, 20 January 2011

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


The Translate method takes a string or longstring 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 has many similarities to the Sirius function $LSTR_TRANSLATE, which is described in the Sirius Functions Reference Manual.

The Translate method takes a CharacterMap object as input. A CharacterMap object maps In ("input table") characters to Out ("output table") characters.

Syntax

%outString = string:Translate( characterMap)

Syntax terms

%outStr A string or Longstring to receive the translated input string.
string The input string or Longstring.
charMap A CharacterMap object variable which indicates the output characters to which specified input characters are to be mapped.

Usage notes

Examples

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

List of intrinsic String methods