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

Last change on this file since 249 was 249, checked in by smasson, 17 years ago

update documentation
File size: 4.7 KB
RevLine 
[89]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>
[104]9    <title>strwhere.pro (SAXO Documentation)</title>
[89]10
11   
[191]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" />
[89]14   
15
16    <script type="text/javascript">
17      function setTitle() {
[104]18        parent.document.title="strwhere.pro (SAXO Documentation)";
[89]19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
[104]26  <h1>SAXO Documentation</h1>
[89]27</div>
28
29
30<div id="main_navbar">
31
32  <table cellspacing="0">
33    <tr>
34     
[189]35      <td><a href="./../../overview.html" title="Overview of library">Overview</a></td>
[89]36     
37
38     
39      <td >Directory</td>
40     
41
42     
[189]43      <td><a href="./../../idldoc-categories.html" title="Browse library by category">Categories</a></td>
[89]44     
45
46     
[189]47      <td><a href="./../../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td>
[89]48     
49
50     
[189]51      <td><a href="./../../search-page.html" title="Search library">Search</a></td>
[89]52     
53
54      <td id="selected">File</td>
55
56     
[189]57      <td><a href="../../../../ToBeReviewed/STRING//strwhere.pro" title="Source code of a file">Source</a></td>
[89]58     
59
60     
[189]61      <td><a href="./../../idldoc-help.html" title="Help on IDLdoc">Help</a></td>
[89]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
[189]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>
[89]75
76</div>
77
78
79    <div id="container">
80
[189]81      <h1 class="directory"><a href="directory-overview.html">ToBeReviewed/STRING/</a></h1>
[89]82      <h2 class="pro_file">strwhere.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
[142]89      <div id="file_comments">
[163]90 return position *array* for occurrence of a character in a string
[142]91</div>
[89]92
93     
94
95     
96
97     
98
99     
100
101      <div id="routine_details">
102       
103
104        <div class="routine_details" id="_strwhere">
105
[142]106          <h2><a class="top" href="#container">top</a>strwhere <span class="categories">
[157]107 String
[142]108</span></h2>
[89]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">
[142]114</div>
[89]115
[242]116          <h3>Return value</h3><div class="preformat">
117 The number of matches that were found
[89]118
[242]119  The function returns an index array similar to the
[142]120  result of the where function
[89]121</div>
122
123         
124            <h3>Parameters</h3>
125       
126           
127            <h4 id="_strwhere_param_str">str&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[142]128              <span class="attr">in</span>
[89]129             
130             
[142]131              <span class="attr">required</span>
[89]132             
133             
134             
135             
136            </h4>
137       
[142]138          <div class="comments">
139 the string
140</div>
[89]141           
142            <h4 id="_strwhere_param_schar">schar&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
[142]143              <span class="attr">in</span>
[89]144             
145             
[142]146              <span class="attr">required</span>
[89]147             
148             
149             
150             
151            </h4>
152       
[142]153          <div class="comments">
154 the character to look for
155</div>
[89]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
[142]175          <h3>Examples</h3><div class="preformat">
[242]176 IDL> ind = strwhere('abcabcabc','a')
177 IDL> print, ind
178 [ 0, 3, 6 ]
[142]179</div>
180          <h3>Version history</h3>
[89]181         
[142]182          <h4>Version</h4><div class="preformat">
[242]183 $Id: strwhere.pro 238 2007-03-27 13:43:18Z pinsard $
[142]184</div>
185          <h4>History</h4><div class="preformat">
186        mgs, 02 Jun 1998: VERSION 1.00
[242]187        bmy, 30 Jun 1998: - now returns COUNT, the number
[142]188                            of matches that are found (this is
189                            analogous to the WHERE command)
190</div>
[89]191         
192         
193         
194         
195         
196         
197         
198       
199         
200         
201         
202         
203         
204         
205         
206       
[163]207          <h3>Statistics</h3>
208          <table class="statistics">
209            <tr><td>McCabe cyclic</td><td>           2</td></tr>
210            <tr><td>McCabe essential</td><td>           1</td></tr>
211            <tr><td>McCabe modular design</td><td>           1</td></tr>
212          </table>
[89]213         
214       
215        </div>
216       
217      </div>
218
219     
220
221      <div id="tagline">Produced by IDLdoc 2.0.</div>
222
223    </div>
224
225  </body>
[249]226</html>
Note: See TracBrowser for help on using the repository browser.