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

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

start to modify headers of Postscript *.pro files for better idldoc output + change the title of idldoc output in html to SAXO Documentation
File size: 7.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>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?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="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?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">getwrd.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="_GETWRD">
103
104          <h2><a class="top" href="#container">top</a>GETWRD </h2>
105       
106          <p class="header">
107            <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>
108       
109          <div class="comments">
110 NAME:
111       GETWRD
112 PURPOSE:
113       Return the n'th word from a text string.
114 CATEGORY:
115 CALLING SEQUENCE:
116       wrd = getwrd(txt, n, [m])
117 INPUTS:
118       txt = text string to extract from.         in
119       n = word number to get (first = 0 = def).  in
120       m = optional last word number to get.      in
121 KEYWORD PARAMETERS:
122       Keywords:
123         LOCATION = l.  Return word n string location.
124         DELIMITER = d. Set word delimiter (def = space & tab).
125         /LAST means n is offset from last word.  So n=0 gives
126           last word, n=-1 gives next to last, ...
127           If n=-2 and m=0 then last 3 words are returned.
128         /NOTRIM suppresses whitespace trimming on ends.
129         NWORDS=n.  Returns number of words in string.
130 OUTPUTS:
131       wrd = returned word or words.              out
132 COMMON BLOCKS:
133       getwrd_com
134 NOTES:
135       Note: If a NULL string is given (txt="") then the last string
136             given is used.  This saves finding the words again.
137             If m > n wrd will be a string of words from word n to
138             word m.  If no m is given wrd will be a single word.
139             n<0 returns text starting at word abs(n) to string end
140             If n is out of range then a null string is returned.
141             See also nwrds.
142 MODIFICATION HISTORY:
143       Ray Sterner,  6 Jan, 1985.
144       R. Sterner, Fall 1989 --- converted to SUN.
145       R. Sterner, Jan 1990 --- added delimiter.
146       R. Sterner, 18 Mar, 1990 --- added /LAST.
147       R. Sterner, 31 Jan, 1991 --- added /NOTRIM.
148       R. Sterner, 20 May, 1991 --- Added common and NULL string.
149       R. Sterner, 13 Dec, 1992 --- Made tabs equivalent to spaces.
150       R. Sterner,  4 Jan, 1993 --- Added NWORDS keyword.
151       Johns Hopkins University Applied Physics Laboratory.
152
153 Copyright (C) 1985, Johns Hopkins University/Applied Physics Laboratory
154 This software may be used, copied, or redistributed as long as it is not
155 sold and this copyright notice is reproduced on each copy made.  This
156 routine is provided as is without any express or implied warranties
157 whatsoever.  Other limitations apply as described in the file disclaimer.txt.</div>
158
159         
160
161         
162            <h3>Parameters</h3>
163       
164           
165            <h4 id="_GETWRD_param_TXTSTR">TXTSTR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
166             
167             
168             
169             
170             
171             
172             
173             
174            </h4>
175       
176          <div class="comments"></div>
177           
178            <h4 id="_GETWRD_param_NTH">NTH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
179             
180             
181             
182             
183             
184             
185             
186             
187            </h4>
188       
189          <div class="comments"></div>
190           
191            <h4 id="_GETWRD_param_MTH">MTH&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
192             
193             
194             
195             
196             
197             
198             
199             
200            </h4>
201       
202          <div class="comments"></div>
203           
204
205         
206
207         
208
209            <h3>Keywords</h3>
210           
211            <h4 id="_GETWRD_keyword_help">help&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
212             
213             
214             
215             
216             
217             
218             
219             
220            </h4>
221       
222            <div class="comments"></div>
223           
224            <h4 id="_GETWRD_keyword_location">location&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
225             
226             
227             
228             
229             
230             
231             
232             
233            </h4>
234       
235            <div class="comments"></div>
236           
237            <h4 id="_GETWRD_keyword_delimiter">delimiter&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
238             
239             
240             
241             
242             
243             
244             
245             
246            </h4>
247       
248            <div class="comments"></div>
249           
250            <h4 id="_GETWRD_keyword_notrim">notrim&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
251             
252             
253             
254             
255             
256             
257             
258             
259            </h4>
260       
261            <div class="comments"></div>
262           
263            <h4 id="_GETWRD_keyword_last">last&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
264             
265             
266             
267             
268             
269             
270             
271             
272            </h4>
273       
274            <div class="comments"></div>
275           
276            <h4 id="_GETWRD_keyword_nwords">nwords&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
277             
278             
279             
280             
281             
282             
283             
284             
285            </h4>
286       
287            <div class="comments"></div>
288           
289         
290
291         
292         
293         
294         
295         
296         
297         
298         
299         
300         
301         
302         
303       
304          <h3>Other attributes</h3>
305         
306         
307         
308         
309         
310          <h4>Common blocks used</h4><div class="value">getwrd_com</div>
311       
312         
313       
314        </div>
315       
316      </div>
317
318     
319
320      <div id="tagline">Produced by IDLdoc 2.0.</div>
321
322    </div>
323
324  </body>
325</html>
Note: See TracBrowser for help on using the repository browser.