source: trunk/SRC/Documentation/idldoc_html_output/Textoidl/strtrans.html @ 338

Last change on this file since 338 was 338, checked in by smasson, 16 years ago

update documentation
File size: 6.8 KB
Line 
1
2<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4
5<!-- Generated by IDLdoc 2.0 -->
6
7<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
8  <head>
9    <title>strtrans.pro (SAXO Documentation)</title>
10
11   
12    <link rel="stylesheet" type="text/css" media="all" href="./../main_files.css" />
13    <link rel="stylesheet" type="text/css" media="print" href="./../main_files_print.css" />
14   
15
16    <script type="text/javascript">
17      function setTitle() {
18        parent.document.title="strtrans.pro (SAXO Documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>SAXO Documentation</h1>
27</div>
28
29
30<div id="main_navbar">
31
32  <table cellspacing="0">
33    <tr>
34     
35      <td><a href="./../overview.html" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../idldoc-categories.html" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../search-page.html" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td><a href="../../../Textoidl//strtrans.pro" title="Source code of a file">Source</a></td>
58     
59
60     
61      <td><a href="./../idldoc-help.html" title="Help on IDLdoc">Help</a></td>
62     
63
64      <td >Etc</td>
65
66      <td id="flexible">Developer&nbsp;documentation</td>
67    </tr>
68  </table>
69
70</div>
71
72<div id="secondary_navbar">
73
74<a href="strcnt.html">&lt;&lt;prev file</a> | <a href="sub_sup_idl.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="strtrans.html" target="_TOP">view single page</a> | <a href="./../index.html" target="_TOP">view frames</a>&nbsp;&nbsp;&nbsp;&nbsp;summary: fields | routine&nbsp;&nbsp;&nbsp;&nbsp;details: <a href="#routine_details">routine</a>
75
76</div>
77
78
79    <div id="container">
80
81      <h1 class="directory"><a href="directory-overview.html">Textoidl/</a></h1>
82      <h2 class="pro_file">strtrans.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments"></div>
90
91     
92
93     
94
95     
96
97     
98
99      <div id="routine_details">
100       
101
102        <div class="routine_details" id="_strtrans">
103
104          <h2><a class="top" href="#container">top</a>strtrans </h2>
105       
106          <p class="header">
107            <span class="result">result = </span>strtrans(<span class="result"><a href="#_strtrans_param_InputString">InputString</a>, <a href="#_strtrans_param_from">from</a>, <a href="#_strtrans_param_to">to</a>, <a href="#_strtrans_param_ned">ned</a></span>, <a href="#_strtrans_keyword_HELP">HELP</a>=<span class="result">HELP</span>)</p>
108       
109          <div class="comments">
110 NAME:
111       STRTRANS
112 PURPOSE:
113       Translate all occurences of one substring to another.
114 CATEGORY:
115       text/strings
116 CALLING SEQUENCE:
117       new = strtrans(oldstr,from,to,ned)
118 INPUTS:
119       oldstr -- string on which to operate.              in
120                 May be an array.
121       from   -- substrings to be translated. May be      in
122                 an array.
123       to     -- what strings in from should be           in
124                 translated to. May be an array.
125 KEYWORD PARAMETERS:
126       /HELP  -- Set this to print useful message and
127                 exit.
128 OUTPUTS:
129       new    -- Translated string. Array if oldstr is    out         
130                 an array.
131       ned    -- number of substitutions performed in     out
132                 oldstr.  Array if oldstr is an array.
133 COMMON BLOCKS:
134 SIDE EFFECTS:
135 NOTES:
136       - Any of old, from, and to can be arrays. 
137       - from and to must have the same number of elements.
138 EXAMPLE:
139       inp='Many*bad!chars+in_here'
140       from=['*','!','+','_']
141       to  =[' ',' ',' ',' ']
142       out = strtrans(inp,from,to,ned)
143       Will produce out='Many bad chars in here', and set ned to 4.
144 MODIFICATION HISTORY:
145       $Id: strtrans.pro 325 2007-12-06 10:04:53Z pinsard $
146       $Log: strtrans.pro,v $
147       Revision 1.7  2004/06/15 17:25:54  mcraig
148       Fixed bug in regular expression, changed array notation to square brackets
149
150       Revision 1.6  2004/01/11 01:49:00  mcraig
151       Changed format of one array to newer [] style to avoidf conflict with function name in astro library.
152
153       Revision 1.5  2001/11/23 21:14:35  mcraig
154       Added keywords /EXTRACT, /PRESERVE_NULL, /REGEX to call to
155       strsplit. This comes very close to reproducing the behavior of the
156       obsolete routine str_sep.
157
158       Revision 1.4  2001/11/21 19:13:23  mcraig
159       Changed str_sep to strsplit. The former is now considered obsolete by RSI.
160
161       Revision 1.3  1996/06/14 20:00:27  mcraig
162       Updated Copyright info.
163
164       Revision 1.2  1996/05/09 00:22:17  mcraig
165       Sped up significantly by using str_sep to handle the translation.  No longer
166       relies on routines fromother user libraries.
167
168       Revision 1.1  1996/01/31 18:47:37  mcraig
169       Initial revision
170
171 RELEASE:
172       $Name: Rel_2_1_2 $
173
174 COPYRIGHT:
175  Copyright (C) 1996 The Regents of the University of California, All
176  Rights Reserved.  Written by Matthew W. Craig.
177  See the file COPYRIGHT for restrictions on distrubting this code.
178  This code comes with absolutely NO warranty; see DISCLAIMER for details.</div>
179
180         
181
182         
183            <h3>Parameters</h3>
184       
185           
186            <h4 id="_strtrans_param_InputString">InputString&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
187             
188             
189             
190             
191             
192             
193             
194             
195            </h4>
196       
197          <div class="comments"></div>
198           
199            <h4 id="_strtrans_param_from">from&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
200             
201             
202             
203             
204             
205             
206             
207             
208            </h4>
209       
210          <div class="comments"></div>
211           
212            <h4 id="_strtrans_param_to">to&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
213             
214             
215             
216             
217             
218             
219             
220             
221            </h4>
222       
223          <div class="comments"></div>
224           
225            <h4 id="_strtrans_param_ned">ned&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
226             
227             
228             
229             
230             
231             
232             
233             
234            </h4>
235       
236          <div class="comments"></div>
237           
238
239         
240
241         
242
243            <h3>Keywords</h3>
244           
245            <h4 id="_strtrans_keyword_HELP">HELP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
246             
247             
248             
249             
250             
251             
252             
253             
254            </h4>
255       
256            <div class="comments"></div>
257           
258         
259
260         
261         
262         
263         
264         
265         
266         
267         
268         
269         
270         
271         
272       
273         
274         
275         
276         
277         
278         
279         
280       
281          <h3>Statistics</h3>
282          <table class="statistics">
283            <tr><td>McCabe cyclic</td><td>           8</td></tr>
284            <tr><td>McCabe essential</td><td>           1</td></tr>
285            <tr><td>McCabe modular design</td><td>           1</td></tr>
286          </table>
287         
288       
289        </div>
290       
291      </div>
292
293     
294
295      <div id="tagline">Produced by IDLdoc 2.0.</div>
296
297    </div>
298
299  </body>
300</html>
Note: See TracBrowser for help on using the repository browser.