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

Last change on this file since 163 was 163, checked in by navarro, 18 years ago

header improvements : type of parameters and keywords, default values, spell checking + idldoc assistant (IDL online_help)

File size: 3.5 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> COUNT {out}{optional}
82 The number of matches that were found
83
84  The function returns an index array similar to the
85  result of the where 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>
145        ind = strwhere('abcabcabc','a')
146
147        ; returns [ 0, 3, 6 ]
148
149    <h3>Version history</h3>
150   
151    <h4>Version</h4>
152 $Id: strwhere.pro 157 2006-08-21 09:01:50Z navarro $
153
154    <h4>History</h4>
155        mgs, 02 Jun 1998: VERSION 1.00
156        bmy, 30 Jun 1998: - now returns COUNT, the number
157                            of matches that are found (this is
158                            analogous to the WHERE command)
159
160   
161
162   
163   
164   
165   
166   
167
168   
169   
170   
171   
172   
173   
174   
175
176    <font size="-3"><p>&nbsp;</p></font>
177    <hr size="1" color="#CCCCCC"/>
178     
179
180   
181
182    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0 on Tue Aug 29 14:50:32 2006.</font></p>
183
184  </body>
185</html>
Note: See TracBrowser for help on using the repository browser.