source: trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/STRING/strsed.html @ 338

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

update documentation
File size: 4.4 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>strsed.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="strsci.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="strtok.html"><img src="./../../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">ToBeReviewed/STRING/</font></h1>
58    <h2>strsed.pro</h2>
59
60    <dl>
61    </dl>
62
63     
64 replace one (or more) character(s)/string(s) in a string array
65 "modern" version of the obsolete strrepl
66
67
68   
69
70     
71      <a name="#_strsed"></a>
72
73      <h2>strsed  <font size="-1" color="#006633">
74 String
75</font></h2>
76
77      <p><font face="Courier"><i>result = </i>strsed(<i><a href="#_strsed_keyword_str">str</a>, <a href="#_strsed_keyword_exp1">exp1</a>, <a href="#_strsed_keyword_exp2">exp2</a></i>, <a href="#_strsed_keyword_FOLD_CASE">FOLD_CASE</a>=<i>FOLD_CASE</i>)</font></p>
78
79   
80
81
82    <h3>Return value</h3>
83 string array or scalar
84
85
86   
87    <h3>Parameters</h3>
88   
89
90    <a name="#_strsed_keyword_str"></a>
91    <h4>str&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
92      <font size="-1" color="#006633">in</font>
93     
94     
95      <font size="-1" color="#006633">required</font>
96     
97      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>string array or scalar</i></font>
98     
99     
100    </h4>
101
102   
103 the string to be changed
104
105   
106
107    <a name="#_strsed_keyword_exp1"></a>
108    <h4>exp1&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
109      <font size="-1" color="#006633">in</font>
110     
111     
112      <font size="-1" color="#006633">required</font>
113     
114      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string</i></font>
115     
116     
117    </h4>
118
119   
120 a single regular expression (as implemented by the STREGEX function).
121
122   
123
124    <a name="#_strsed_keyword_exp2"></a>
125    <h4>exp2&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
126      <font size="-1" color="#006633">in</font>
127     
128     
129      <font size="-1" color="#006633">required</font>
130     
131      <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string</i></font>
132     
133     
134    </h4>
135
136   
137 replacement character/string
138
139   
140   
141
142   
143    <h3>Keywords</h3>
144
145   
146    <a name="#_strsed_keyword_FOLD_CASE"></a>
147    <h4>FOLD_CASE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
148     
149     
150     
151     
152     
153     
154     
155     
156    </h4>
157
158   
159 Indicates that the regular expression matching should be done in a case-insensitive fashion.
160
161   
162   
163
164    <h3>Examples</h3><pre>
165
166    IDL> abc = 'abcdefghijklmnopqrstuvwxyz'
167    IDL> print, strsed(abc, 'm', 'M')
168    abcdefghijklMnopqrstuvwxyz
169    IDL> print, strsed(abc, 'm.*t', 'M_T')
170    abcdefghijklM_Tuvwxyz
171    IDL> a = 'abcabcabc'
172    IDL> help, strsed([abc, a, 'eee'], 'abc', 'XXX_')
173    <Expression>    STRING    = Array[3]
174    IDL> print, strsed([abc, a, 'eee'], 'abc', 'XXX_')
175    XXX_defghijklmnopqrstuvwxyz XXX_XXX_XXX_ eee
176
177    </pre><h3>Version history</h3>
178   
179    <h4>Version</h4>
180 $Id: strsed.pro 327 2007-12-13 16:22:35Z pinsard $
181    <h4>History</h4>
182 Sept 2006: Sebastien Masson (smasson@lodyc.jussieu.fr)
183
184   
185
186   
187   
188   
189   
190   
191
192   
193   
194   
195   
196   
197   
198   
199
200    <font size="-3"><p>&nbsp;</p></font>
201    <hr size="1" color="#CCCCCC"/>
202     
203
204   
205
206    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
207
208  </body>
209</html>
Note: See TracBrowser for help on using the repository browser.