source: trunk/SRC/Documentation/idldoc_assistant_output/Textoidl/strtrans.html @ 187

Last change on this file since 187 was 187, checked in by pinsard, 18 years ago

introducing hyperlinks in idldoc outputs (2/2)
File size: 5.6 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>strtrans.pro (SAXO Documentation Assistant)</title>
6  </head>
7
8  <body text="#000000" bgcolor="#FFFFFF">
9
10   
11<!-- Navbar template takes a structure with the following fields:
12       overview_href :
13       overview_selected :
14       dir_overview_href :
15       dir_overview_selected :
16       categories_href :
17       categories_selected :
18       index_href :
19       index_selected :
20       search_href :
21       search_selected :
22       file_selected :
23       source_href :
24       source_selected :
25       help_href :
26       help_selected :
27       etc_selected :
28
29       prev_file_href :
30       next_file_href :
31
32       view_single_page_href :
33       view_frames_href :
34
35       summary_fields_href :
36       summary_routine_href :
37       details_routine_href :
38
39       title :
40       subtitle :
41       user :
42-->
43
44
45<table border="0" cellpadding="0" cellspacing="0" width="98%" bgcolor="#F0F0FF" valign="bottom">
46  <tr>
47    <td width="10%">
48<a href="strcnt.html"><img src="./../prev.gif" border="0" alt="Previous"></a></td>
49    <td width="80%" align="center" valign="center">
50<font size=-1><i>SAXO Documentation Assistant</i>: <a href="./../home.html">Overview</a></font></td>
51    <td width="10%" align="right">
52<a href="sub_sup_idl.html"><img src="./../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">Textoidl/</font></h1>
58    <h2>strtrans.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64
65   
66
67     
68      <a name="#_strtrans"></a>
69
70      <h2>strtrans  </h2>
71
72      <p><font face="Courier"><i>result = </i>strtrans(<i><a href="#_strtrans_keyword_InputString">InputString</a>, <a href="#_strtrans_keyword_from">from</a>, <a href="#_strtrans_keyword_to">to</a>, <a href="#_strtrans_keyword_ned">ned</a></i>, <a href="#_strtrans_keyword_HELP">HELP</a>=<i>HELP</i>)</font></p>
73
74   
75 NAME:
76       STRTRANS
77 PURPOSE:
78       Translate all occurences of one substring to another.
79 CATEGORY:
80       text/strings
81 CALLING SEQUENCE:
82       new = strtrans(oldstr,from,to,ned)
83 INPUTS:
84       oldstr -- string on which to operate.              in
85                 May be an array.
86       from   -- substrings to be translated. May be      in
87                 an array.
88       to     -- what strings in from should be           in
89                 translated to. May be an array.
90 KEYWORD PARAMETERS:
91       /HELP  -- Set this to print useful message and
92                 exit.
93 OUTPUTS:
94       new    -- Translated string. Array if oldstr is    out         
95                 an array.
96       ned    -- number of substitutions performed in     out
97                 oldstr.  Array if oldstr is an array.
98 COMMON BLOCKS:
99 SIDE EFFECTS:
100 NOTES:
101       - Any of old, from, and to can be arrays. 
102       - from and to must have the same number of elements.
103 EXAMPLE:
104       inp='Many*bad!chars+in_here'
105       from=['*','!','+','_']
106       to  =[' ',' ',' ',' ']
107       out = strtrans(inp,from,to,ned)
108       Will produce out='Many bad chars in here', and set ned to 4.
109 MODIFICATION HISTORY:
110       $Id: strtrans.pro 134 2006-07-07 10:19:08Z navarro $
111       $Log: strtrans.pro,v $
112       Revision 1.7  2004/06/15 17:25:54  mcraig
113       Fixed bug in regular expression, changed array notation to square brackets
114
115       Revision 1.6  2004/01/11 01:49:00  mcraig
116       Changed format of one array to newer [] style to avoidf conflict with function name in astro library.
117
118       Revision 1.5  2001/11/23 21:14:35  mcraig
119       Added keywords /EXTRACT, /PRESERVE_NULL, /REGEX to call to
120       strsplit. This comes very close to reproducing the behavior of the
121       obsolete routine str_sep.
122
123       Revision 1.4  2001/11/21 19:13:23  mcraig
124       Changed str_sep to strsplit. The former is now considered obsolete by RSI.
125
126       Revision 1.3  1996/06/14 20:00:27  mcraig
127       Updated Copyright info.
128
129       Revision 1.2  1996/05/09 00:22:17  mcraig
130       Sped up significantly by using str_sep to handle the translation.  No longer
131       relies on routines fromother user libraries.
132
133       Revision 1.1  1996/01/31 18:47:37  mcraig
134       Initial revision
135
136 RELEASE:
137       $Name: Rel_2_1_2 $
138
139 COPYRIGHT:
140  Copyright (C) 1996 The Regents of the University of California, All
141  Rights Reserved.  Written by Matthew W. Craig.
142  See the file COPYRIGHT for restrictions on distrubting this code.
143  This code comes with absolutely NO warranty; see DISCLAIMER for details.
144
145   
146
147   
148    <h3>Parameters</h3>
149   
150
151    <a name="#_strtrans_keyword_InputString"></a>
152    <h4>InputString&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
153     
154     
155     
156     
157     
158     
159     
160     
161    </h4>
162
163   
164   
165
166    <a name="#_strtrans_keyword_from"></a>
167    <h4>from&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
168     
169     
170     
171     
172     
173     
174     
175     
176    </h4>
177
178   
179   
180
181    <a name="#_strtrans_keyword_to"></a>
182    <h4>to&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
183     
184     
185     
186     
187     
188     
189     
190     
191    </h4>
192
193   
194   
195
196    <a name="#_strtrans_keyword_ned"></a>
197    <h4>ned&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
198     
199     
200     
201     
202     
203     
204     
205     
206    </h4>
207
208   
209   
210   
211
212   
213    <h3>Keywords</h3>
214
215   
216    <a name="#_strtrans_keyword_HELP"></a>
217    <h4>HELP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
218     
219     
220     
221     
222     
223     
224     
225     
226    </h4>
227
228   
229   
230   
231
232   
233   
234   
235   
236   
237   
238
239   
240   
241   
242   
243   
244
245   
246   
247   
248   
249   
250   
251   
252
253    <font size="-3"><p>&nbsp;</p></font>
254    <hr size="1" color="#CCCCCC"/>
255     
256
257   
258
259    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
260
261  </body>
262</html>
Note: See TracBrowser for help on using the repository browser.