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

Last change on this file since 89 was 89, checked in by pinsard, 18 years ago

add idldoc html output. see Documentation/idldoc_html_output/index.html
File size: 4.4 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 (IDLdoc API 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 (IDLdoc API documentation)";
19      }
20    </script>
21  </head>
22
23  <body onload="setTitle();">
24
25    <div id="navbar_title">
26  <h1>IDLdoc API 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?format=raw" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../../search-page.html?format=raw" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td >Source</td>
58     
59
60     
61      <td><a href="./../../idldoc-help.html?format=raw" 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="strtrans.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?format=raw" 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?format=raw">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"></div>
90
91     
92
93     
94
95     
96
97     
98
99      <div id="routine_details">
100       
101
102        <div class="routine_details" id="_strwhere">
103
104          <h2><a class="top" href="#container">top</a>strwhere </h2>
105       
106          <p class="header">
107            <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>
108       
109          <div class="comments">
110 NAME:
111        STRWHERE  (function)
112
113 PURPOSE:
114        return position *array* for occurence of a character in
115        a string
116
117 CATEGORY:
118        string tools
119
120 CALLING SEQUENCE:
121        pos = STRWHERE(str, schar [,Count] )
122
123 INPUTS:
124        STR -> the string
125
126        SCHAR -> the character to look for
127
128 KEYWORD PARAMETERS:
129        none.
130
131 OUTPUTS:
132        COUNT -> (optional) The number of matches that were found
133
134        The function returns an index array similar to the
135        result of the where function
136
137 SUBROUTINES:
138
139 REQUIREMENTS:
140
141 NOTES:
142
143 EXAMPLE:
144        ind = strwhere('abcabcabc','a')
145
146        ; returns [ 0, 3, 6 ]
147
148 MODIFICATION HISTORY:
149        mgs, 02 Jun 1998: VERSION 1.00
150        bmy, 30 Jun 1998: - now returns COUNT, the number
151                            of matches that are found (this is
152                            analogous to the WHERE command)
153</div>
154
155         
156
157         
158            <h3>Parameters</h3>
159       
160           
161            <h4 id="_strwhere_param_str">str&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
162             
163             
164             
165             
166             
167             
168             
169             
170            </h4>
171       
172          <div class="comments"></div>
173           
174            <h4 id="_strwhere_param_schar">schar&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
175             
176             
177             
178             
179             
180             
181             
182             
183            </h4>
184       
185          <div class="comments"></div>
186           
187            <h4 id="_strwhere_param_Count">Count&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
188             
189             
190             
191             
192             
193             
194             
195             
196            </h4>
197       
198          <div class="comments"></div>
199           
200
201         
202
203         
204
205         
206         
207         
208         
209         
210         
211         
212         
213         
214         
215         
216         
217       
218         
219         
220         
221         
222         
223         
224         
225       
226         
227       
228        </div>
229       
230      </div>
231
232     
233
234      <div id="tagline">Produced by IDLdoc 2.0.</div>
235
236    </div>
237
238  </body>
239</html>
Note: See TracBrowser for help on using the repository browser.