source: trunk/SRC/Documentation/idldoc_html_output/Obsolete/strrepl.html @ 338

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

update documentation
File size: 5.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>strrepl.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="strrepl.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="../../../Obsolete//strrepl.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="norme.html">&lt;&lt;prev file</a> | <a href="vairdate.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="strrepl.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">Obsolete/</a></h1>
82      <h2 class="pro_file">strrepl.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 replace one (or more) character(s)/string(s) in a string
91 --- OBSOLETE --- you should better use <a href="..//ToBeReviewed/STRING/strsed.html">strsed</a>
92</div>
93
94     
95
96     
97
98     
99
100     
101
102      <div id="routine_details">
103       
104
105        <div class="routine_details" id="_strrepl">
106
107          <h2><a class="top" href="#container">top</a>strrepl <span class="categories">
108 String
109</span></h2>
110       
111          <p class="header">
112            <span class="result">result = </span>strrepl(<span class="result"><a href="#_strrepl_param_str">str</a>, <a href="#_strrepl_param_arg2">arg2</a>, <a href="#_strrepl_param_rchar">rchar</a></span>)</p>
113       
114          <div class="comments">
115</div>
116
117          <h3>Return value</h3><div class="preformat">
118 another string
119</div>
120
121         
122            <h3>Parameters</h3>
123       
124           
125            <h4 id="_strrepl_param_str">str&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
126              <span class="attr">in</span>
127             
128             
129              <span class="attr">required</span>
130             
131             
132             
133             
134            </h4>
135       
136          <div class="comments">
137 the string to be changed
138</div>
139           
140            <h4 id="_strrepl_param_arg2">arg2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
141              <span class="attr">in</span>
142             
143             
144              <span class="attr">required</span>
145             
146             
147             
148             
149            </h4>
150       
151          <div class="comments">
152 position of the character(s) to be replaced or a string to be changed in STR.
153</div>
154           
155            <h4 id="_strrepl_param_rchar">rchar&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
156              <span class="attr">in</span>
157             
158             
159              <span class="attr">required</span>
160             
161             
162             
163             
164            </h4>
165       
166          <div class="comments">
167 replacement character/string
168</div>
169           
170
171         
172
173         
174
175          <h3>Examples</h3><div class="preformat">
176        ; Convert one letter into upper case
177
178        abc = 'abcdefghijklmnopqrstuvwxyz'
179        print,strrepl(abc,strpos(abc,'m'),'M')
180
181        ; prints "abcdefghijklMnopqrstuvwxyz"
182
183
184        ; Use with strwhere function
185        a = 'abcabcabc'
186        print,strrepl(a,strwhere(a,'a'),'#')
187
188        ; prints  "#bc#bc#bc#bc#bc"
189
190       IDL> print, strrepl(a,'bc','!eeee!')
191       a!eeee!a!eeee!a!eeee!
192       IDL> print, strrepl(a,'b','0000')
193       a0000ca0000ca0000
194       IDL> print, strrepl(a,'toto','0000')
195       abcabcabc
196</div>
197          <h3>Version history</h3>
198         
199          <h4>Version</h4><div class="preformat">
200 $Id: strrepl.pro 325 2007-12-06 10:04:53Z pinsard $
201</div>
202          <h4>History</h4><div class="preformat">
203        mgs, 02 Jun 1998: VERSION 1.00
204 Copyright (C) 1998, Martin Schultz, Harvard University
205 This software is provided as is without any warranty
206 whatsoever. It may be freely used, copied or distributed
207 for non-commercial purposes. This copyright notice must be
208 kept with any copy of this software. If this software shall
209 be used commercially or sold as part of a larger package,
210 please contact the author to arrange payment.
211 Bugs and comments should be directed to mgs@io.harvard.edu
212 with subject "IDL routine strrepl"
213
214        sebastien Masson (smlod@ipsl.jussieu.fr)
215</div>
216         
217         
218          <h3>Known issues</h3>
219         
220         
221         
222          <h4>Restrictions</h4><div class="preformat">
223 Known shortcoming: if index is an array, it must contain all
224 valid elements (only the first entry is checked).
225</div>
226       
227         
228         
229         
230         
231         
232         
233         
234       
235          <h3>Statistics</h3>
236          <table class="statistics">
237            <tr><td>McCabe cyclic</td><td>          11</td></tr>
238            <tr><td>McCabe essential</td><td>           1</td></tr>
239            <tr><td>McCabe modular design</td><td>           1</td></tr>
240          </table>
241         
242       
243        </div>
244       
245      </div>
246
247     
248
249      <div id="tagline">Produced by IDLdoc 2.0.</div>
250
251    </div>
252
253  </body>
254</html>
Note: See TracBrowser for help on using the repository browser.