Translate (String function): Difference between revisions

From m204wiki
Jump to navigation Jump to search
mNo edit summary
 
(30 intermediate revisions by 5 users not shown)
Line 1: Line 1:
The Translate method takes a string or longstring input and outputs a copy of it in which       
{{Template:String:Translate subtitle}}
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 [[aracterMap class|CharacterMap]] object maps In ("input table")
characters to Out ("output table") characters.     
===Translate syntax===                                                                           
  %outStr = string:translate(charMap)                                                           
===Syntax Terms===                                                                               
<dl>                                                                                             
<dt>%outStr                                                                                     
<dd>A string or Longstring to receive the translated input string.                               
<dt>string                                                                                       
<dd>The input string or Longstring.                                                             
<dt>charMap                                                                                     
<dd>A CharacterMap object variable which indicates the output characters to which specified input characters are to be mapped.
                                                                                                 
</dl>                                                                                           
===Usage Notes===                                                                               
*For information about constructing a CharacterMap object, see [[CharacterMap New constructor]]. 
===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'                                                 
    [[Intrinsic classes#printtext|printText]] {~} = '{%ls:translate(%map)}'
    End                                                           
                                                                   
The result is:                                                     
    %ls:translate(%tr) = 'BBBddd'


===See also===                                                     
<var>Translate</var> 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.  <var>Translate</var> takes a <var>[[characterMap_class|CharacterMap]]</var> object as input which maps <var>In</var> ("input table") characters to <var>Out</var> ("output table") characters.
[[List of intrinsic String methods]]


[[Category:Intrinsic String methods|Translate function]]
==Syntax==
[[Category:Intrinsic methods]]
{{Template:String:Translate syntax}}
===Syntax terms===
<table class="syntaxTable">
<tr><th>%outString</th>
<td>A string or  to receive the translated input <var class="term">string</var>.</td></tr>
<tr><th>string</th>
<td>The method object input string.</td></tr>
<tr><th>characterMap</th>
<td>A <var>[[characterMap_class|CharacterMap]]</var> object variable which defines the relationship (mapping) between input and output characters.</td></tr>
</table>
 
==Usage notes==
<ul>
<li>For information about constructing a <var>CharacterMap</var> object, see <var>[[New_(CharacterMap_constructor)|New]]</var>, the <var>CharacterMap</var> constructor.
</ul>
 
==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 <code>%map</code>:
<p class="code">begin
  %map is object characterMap
  %ls is longstring
 
  %map = new(in='ac',out='Bd')
  %ls = 'aaaccc'
  [[PrintText statement|printText]] {~} = '{%ls:translate(%map)}'
end
</p>
The result is:
<p class="output">%ls:translate(%tr) = 'BBBddd'
</p>
 
==See also==
<ul><li><var>Translate</var> has many similarities to the Sirius function <var>[[$Lstr_Translate]]</var>.</ul>
{{Template:String:Translate footer}}

Latest revision as of 22:42, 5 November 2012

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

  • For information about constructing a CharacterMap object, see New, the CharacterMap constructor.

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

Retrieved from "https://m204wiki.rocketsoftware.com/index.php?title=Translate_(String_function)&oldid=1811"