source: trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/STRING/strwhere.html @ 402

Last change on this file since 402 was 402, checked in by smasson, 15 years ago

update documentation
File size: 4.1 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>strwhere.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="strtok.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="tostr.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>strwhere.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 return position *array* for occurrence of a character in a string
65
66
67   
68
69     
70      <a name="#_strwhere"></a>
71
72      <h2>strwhere  <font size="-1" color="#006633">
73 String
74</font></h2>
75
76      <p><font face="Courier"><i>result = </i>strwhere(<i><a href="#_strwhere_keyword_str">str</a>, <a href="#_strwhere_keyword_schar">schar</a>, <a href="#_strwhere_keyword_count">count</a></i>)</font></p>
77
78   
79
80
81    <h3>Return value</h3>
82 The number of matches that were found
83
84 The function returns an index array similar to the
85 result of the <a href="/Applications/itt/idl64/help/online_help/WHERE.html">WHERE</a> function
86
87
88   
89    <h3>Parameters</h3>
90   
91
92    <a name="#_strwhere_keyword_str"></a>
93    <h4>str&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
94      <font size="-1" color="#006633">in</font>
95     
96     
97      <font size="-1" color="#006633">required</font>
98     
99     
100     
101     
102    </h4>
103
104   
105 the string
106
107   
108
109    <a name="#_strwhere_keyword_schar"></a>
110    <h4>schar&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
111      <font size="-1" color="#006633">in</font>
112     
113     
114      <font size="-1" color="#006633">required</font>
115     
116     
117     
118     
119    </h4>
120
121   
122 the character to look for
123
124   
125
126    <a name="#_strwhere_keyword_count"></a>
127    <h4>count&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
128     
129     
130     
131     
132     
133     
134     
135     
136    </h4>
137
138   
139   
140   
141
142   
143
144    <h3>Examples</h3><pre>
145
146 find position of string "a" in the string "abcabcabc"
147
148   IDL> ind = strwhere('abcabcabc','a')
149   IDL> print, ind
150 [ 0, 3, 6 ]
151
152    </pre><h3>Version history</h3>
153   
154    <h4>Version</h4>
155 $Id: strwhere.pro 378 2008-08-12 12:35:46Z pinsard $
156
157 Copyright (C) 1998, Martin Schultz, Harvard University
158 This software is provided as is without any warranty
159 whatsoever. It may be freely used, copied or distributed
160 for non-commercial purposes. This copyright notice must be
161 kept with any copy of this software. If this software shall
162 be used commercially or sold as part of a larger package,
163 please contact the author to arrange payment.
164 Bugs and comments should be directed to mgs@io.harvard.edu
165 with subject "IDL routine strwhere"
166    <h4>History</h4>
167        mgs, 02 Jun 1998: VERSION 1.00
168        bmy, 30 Jun 1998: - now returns COUNT, the number
169                            of matches that are found (this is
170                            analogous to the WHERE command)
171
172   
173
174   
175   
176   
177   
178   
179
180   
181   
182   
183   
184   
185   
186   
187
188    <font size="-3"><p>&nbsp;</p></font>
189    <hr size="1" color="#CCCCCC"/>
190     
191
192   
193
194    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
195
196  </body>
197</html>
Note: See TracBrowser for help on using the repository browser.