source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/STRING/strwhere.html

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

update documentation
File size: 5.3 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>strwhere.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="strwhere.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="../../../../ToBeReviewed/STRING//strwhere.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="strtok.html">&lt;&lt;prev file</a> | <a href="tostr.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="strwhere.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">ToBeReviewed/STRING/</a></h1>
82      <h2 class="pro_file">strwhere.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 return position *array* for occurrence of a character in a string
91</div>
92
93     
94
95     
96
97     
98
99     
100
101      <div id="routine_details">
102       
103
104        <div class="routine_details" id="_strwhere">
105
106          <h2><a class="top" href="#container">top</a>strwhere <span class="categories">
107 String
108</span></h2>
109       
110          <p class="header">
111            <span class="result">result = </span>strwhere(<span class="result"><a href="#_strwhere_param_str">str</a>, <a href="#_strwhere_param_schar">schar</a>, <a href="#_strwhere_param_count">count</a></span>)</p>
112       
113          <div class="comments">
114</div>
115
116          <h3>Return value</h3><div class="preformat">
117 The number of matches that were found
118
119 The function returns an index array similar to the
120 result of the <a href="/Applications/itt/idl64/help/online_help/WHERE.html">WHERE</a> function
121</div>
122
123         
124            <h3>Parameters</h3>
125       
126           
127            <h4 id="_strwhere_param_str">str&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
128              <span class="attr">in</span>
129             
130             
131              <span class="attr">required</span>
132             
133             
134             
135             
136            </h4>
137       
138          <div class="comments">
139 the string
140</div>
141           
142            <h4 id="_strwhere_param_schar">schar&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
143              <span class="attr">in</span>
144             
145             
146              <span class="attr">required</span>
147             
148             
149             
150             
151            </h4>
152       
153          <div class="comments">
154 the character to look for
155</div>
156           
157            <h4 id="_strwhere_param_count">count&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
158             
159             
160             
161             
162             
163             
164             
165             
166            </h4>
167       
168          <div class="comments"></div>
169           
170
171         
172
173         
174
175          <h3>Examples</h3><div class="preformat">
176
177 find position of string "a" in the string "abcabcabc"
178
179   IDL> ind = strwhere('abcabcabc','a')
180   IDL> print, ind
181 [ 0, 3, 6 ]
182</div>
183          <h3>Version history</h3>
184         
185          <h4>Version</h4><div class="preformat">
186 $Id: strwhere.pro 378 2008-08-12 12:35:46Z pinsard $
187
188 Copyright (C) 1998, Martin Schultz, Harvard University
189 This software is provided as is without any warranty
190 whatsoever. It may be freely used, copied or distributed
191 for non-commercial purposes. This copyright notice must be
192 kept with any copy of this software. If this software shall
193 be used commercially or sold as part of a larger package,
194 please contact the author to arrange payment.
195 Bugs and comments should be directed to mgs@io.harvard.edu
196 with subject "IDL routine strwhere"</div>
197          <h4>History</h4><div class="preformat">
198        mgs, 02 Jun 1998: VERSION 1.00
199        bmy, 30 Jun 1998: - now returns COUNT, the number
200                            of matches that are found (this is
201                            analogous to the WHERE command)
202</div>
203         
204         
205         
206         
207         
208         
209         
210       
211         
212         
213         
214         
215         
216         
217         
218       
219          <h3>Statistics</h3>
220          <table class="statistics">
221            <tr><td>McCabe cyclic</td><td>           2</td></tr>
222            <tr><td>McCabe essential</td><td>           1</td></tr>
223            <tr><td>McCabe modular design</td><td>           1</td></tr>
224          </table>
225         
226       
227        </div>
228       
229      </div>
230
231     
232
233      <div id="tagline">Produced by IDLdoc 2.0.</div>
234
235    </div>
236
237  </body>
238</html>
Note: See TracBrowser for help on using the repository browser.