source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/STRING/getwrd.html @ 191

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

remove format=raw in all html files 2+ : correction for all_plots; suppression of css and correction of Source links in idldoc html output
File size: 7.9 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>getwrd.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="getwrd.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//getwrd.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="getfile.html">&lt;&lt;prev file</a> | <a href="isnumber.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="getwrd.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">getwrd.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 Return the n'th word from a text 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="_getwrd">
105
106          <h2><a class="top" href="#container">top</a>getwrd <span class="categories">
107</span></h2>
108       
109          <p class="header">
110            <span class="result">result = </span>getwrd(<span class="result"><a href="#_getwrd_param_TXTSTR">TXTSTR</a>, <a href="#_getwrd_param_NTH">NTH</a>, <a href="#_getwrd_param_MTH">MTH</a></span>, <a href="#_getwrd_keyword_help">help</a>=<span class="result">help</span>, <a href="#_getwrd_keyword_location">location</a>=<span class="result">location</span>, <a href="#_getwrd_keyword_delimiter">delimiter</a>=<span class="result">delimiter</span>, <a href="#_getwrd_keyword_notrim">notrim</a>=<span class="result">notrim</span>, <a href="#_getwrd_keyword_last">last</a>=<span class="result">last</span>, <a href="#_getwrd_keyword_nwords">nwords</a>=<span class="result">nwords</span>)</p>
111       
112          <div class="comments">
113</div>
114
115          <h3>Return value</h3><div class="preformat"> wrd = returned word or words.
116</div>
117
118         
119            <h3>Parameters</h3>
120       
121           
122            <h4 id="_getwrd_param_TXTSTR">TXTSTR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
123              <span class="attr">in</span>
124             
125             
126              <span class="attr">required</span>
127             
128             
129             
130             
131            </h4>
132       
133          <div class="comments">
134 text string to extract from.
135 The first element is used if txt is an array.
136</div>
137           
138            <h4 id="_getwrd_param_NTH">NTH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
139              <span class="attr">in</span>
140             
141             
142              <span class="attr">required</span>
143             
144             
145             
146             
147            </h4>
148       
149          <div class="comments">
150 word number to get (first = 0 = def)
151</div>
152           
153            <h4 id="_getwrd_param_MTH">MTH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
154              <span class="attr">in</span>
155             
156             
157              <span class="attr">required</span>
158             
159             
160             
161             
162            </h4>
163       
164          <div class="comments">
165 optional last word number to get.
166</div>
167           
168
169         
170
171         
172
173            <h3>Keywords</h3>
174           
175            <h4 id="_getwrd_keyword_help">help&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
176             
177             
178             
179             
180             
181             
182             
183             
184            </h4>
185       
186            <div class="comments"></div>
187           
188            <h4 id="_getwrd_keyword_location">location&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
189             
190             
191             
192             
193             
194             
195             
196             
197            </h4>
198       
199            <div class="comments">
200 = l.  Return word n string location.
201         </div>
202           
203            <h4 id="_getwrd_keyword_delimiter">delimiter&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
204             
205             
206             
207             
208             
209             
210             
211             
212            </h4>
213       
214            <div class="comments">
215 = d. Set word delimiter (def = space & tab).
216         </div>
217           
218            <h4 id="_getwrd_keyword_notrim">notrim&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
219             
220             
221             
222             
223             
224             
225             
226             
227            </h4>
228       
229            <div class="comments">
230 suppresses whitespace trimming on ends.
231 </div>
232           
233            <h4 id="_getwrd_keyword_last">last&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
234             
235             
236             
237             
238             
239             
240             
241             
242            </h4>
243       
244            <div class="comments">
245 means n is offset from last word.  So n=0 gives
246 last word, n=-1 gives next to last, ...
247 If n=-2 and m=0 then last 3 words are returned.
248</div>
249           
250            <h4 id="_getwrd_keyword_nwords">nwords&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
251             
252             
253             
254             
255             
256             
257             
258             
259            </h4>
260       
261            <div class="comments">
262 = n. Returns number of words in string.
263 </div>
264           
265         
266
267         
268          <h3>Version history</h3>
269         
270          <h4>Version</h4><div class="preformat">
271 $Id: getwrd.pro 163 2006-08-29 12:59:46Z navarro $
272</div>
273          <h4>History</h4><div class="preformat">
274       Ray Sterner,  6 Jan, 1985.
275       R. Sterner, Fall 1989 --- converted to SUN.
276       R. Sterner, Jan 1990 --- added delimiter.
277       R. Sterner, 18 Mar, 1990 --- added /LAST.
278       R. Sterner, 31 Jan, 1991 --- added /NOTRIM.
279       R. Sterner, 20 May, 1991 --- Added common and NULL string.
280       R. Sterner, 13 Dec, 1992 --- Made tabs equivalent to spaces.
281       R. Sterner,  4 Jan, 1993 --- Added NWORDS keyword.
282       R. Sterner, 2001 Jan 15 --- Fixed to use first element if not a scalar.
283       Johns Hopkins University Applied Physics Laboratory.
284
285 Copyright (C) 1985, Johns Hopkins University/Applied Physics Laboratory
286 This software may be used, copied, or redistributed as long as it is not
287 sold and this copyright notice is reproduced on each copy made.  This
288 routine is provided as is without any express or implied warranties
289 whatsoever.  Other limitations apply as described in the file disclaimer.txt.
290</div>
291         
292         
293          <h3>Known issues</h3>
294         
295         
296         
297          <h4>Restrictions</h4><div class="preformat">
298 If a NULL string is given (txt="") then the last string
299 given is used.  This saves finding the words again.
300 If m > n wrd will be a string of words from word n to
301 word m.  If no m is given wrd will be a single word.
302 n<0 returns text starting at word abs(n) to string end
303 If n is out of range then a null string is returned.
304 See also nwrds.
305</div>
306       
307          <h3>Other attributes</h3>
308         
309         
310          <h4>Uses routines</h4><div class="preformat">
311 getwrd_com
312 </div>
313         
314         
315          <h4>Common blocks used</h4><div class="preformat">getwrd_com</div>
316       
317          <h3>Statistics</h3>
318          <table class="statistics">
319            <tr><td>McCabe cyclic</td><td>          17</td></tr>
320            <tr><td>McCabe essential</td><td>           2</td></tr>
321            <tr><td>McCabe modular design</td><td>           1</td></tr>
322          </table>
323         
324       
325        </div>
326       
327      </div>
328
329     
330
331      <div id="tagline">Produced by IDLdoc 2.0.</div>
332
333    </div>
334
335  </body>
336</html>
Note: See TracBrowser for help on using the repository browser.