source: trunk/SRC/Documentation/idldoc_html_output/Textoidl/str_token.html @ 376

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

update documentation
File size: 6.1 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>str_token.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="str_token.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="../../../Textoidl//str_token.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="showtex.html">&lt;&lt;prev file</a> | <a href="strcnt.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="str_token.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">Textoidl/</a></h1>
82      <h2 class="pro_file">str_token.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="_str_token">
103
104          <h2><a class="top" href="#container">top</a>str_token </h2>
105       
106          <p class="header">
107            <span class="result">result = </span>str_token(<span class="result"><a href="#_str_token_param_string">string</a>, <a href="#_str_token_param_token">token</a></span>, <a href="#_str_token_keyword_TRIM">TRIM</a>=<span class="result">TRIM</span>, <a href="#_str_token_keyword_HELP">HELP</a>=<span class="result">HELP</span>)</p>
108       
109          <div class="comments">
110 NAME:
111       STR_TOKEN
112 PURPOSE:
113       Retrieve portion of string up to token.
114 CATEGORY:
115       text/strings
116 CALLING SEQUENCE:
117       new = str_token( old, token )
118 INPUTS:
119       old   -- String to be split.  Contains text after    in, out
120                token on output.
121       token -- Token to use in splitting old.              in
122 KEYWORD PARAMETERS:
123       /TRIM -- set to remove leading blanks from old
124                before returning.
125       /HELP -- print useful message and exit.
126 OUTPUTS:
127       new   -- portion of string up to token.              out
128       old   -- portion of old after token.                 out, in
129 COMMON BLOCKS:
130 SIDE EFFECTS:
131       Input parameter old is modified.
132 NOTES:
133       Token may be one or more characters.
134       If token is not found, returns old and sets old to ''.
135 EXAMPLE:
136       If old is 'foo44 bar', then str_token( old, '44' ) would return
137       'foo', and upon return, old will be left with ' bar'.  If /TRIM
138       were set, old would be 'bar' on return.
139
140       If old='xyz', then new=str_token(old,'a') would return with
141       new='xyz' and old=''.
142 THANKS:
143       To D. Linder who wrote GETTOK, part of the goddard library,
144       upon which this is based.
145 MODIFICATION HISTORY:
146       $Id: str_token.pro 163 2006-08-29 12:59:46Z navarro $
147       $Log: str_token.pro,v $
148       Revision 1.1  2000/06/14 19:09:22  mcraig
149       Changed name of strtok str_token to avoid conflict in IDL 5.3.
150
151       Revision 1.3  1996/06/14 20:00:27  mcraig
152       Updated Copyright info.
153
154       Revision 1.2  1996/05/09 00:22:17  mcraig
155       Added built in help.
156
157       Revision 1.1  1996/01/31 18:47:37  mcraig
158       Initial revision
159
160 RELEASE:
161       $Name: Rel_2_1_2 $
162
163 COPYRIGHT:
164  Copyright (C) 1996 The Regents of the University of California, All
165  Rights Reserved.  Written by Matthew W. Craig.
166  See the file COPYRIGHT for restrictions on distrubting this code.
167  This code comes with absolutely NO warranty; see DISCLAIMER for details.</div>
168
169         
170
171         
172            <h3>Parameters</h3>
173       
174           
175            <h4 id="_str_token_param_string">string&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="_str_token_param_token">token&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
189             
190             
191             
192             
193             
194             
195             
196             
197            </h4>
198       
199          <div class="comments"></div>
200           
201
202         
203
204         
205
206            <h3>Keywords</h3>
207           
208            <h4 id="_str_token_keyword_TRIM">TRIM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
209             
210             
211             
212             
213             
214             
215             
216             
217            </h4>
218       
219            <div class="comments"></div>
220           
221            <h4 id="_str_token_keyword_HELP">HELP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
222             
223             
224             
225             
226             
227             
228             
229             
230            </h4>
231       
232            <div class="comments"></div>
233           
234         
235
236         
237         
238         
239         
240         
241         
242         
243         
244         
245         
246         
247         
248       
249         
250         
251         
252         
253         
254         
255         
256       
257          <h3>Statistics</h3>
258          <table class="statistics">
259            <tr><td>McCabe cyclic</td><td>           4</td></tr>
260            <tr><td>McCabe essential</td><td>           1</td></tr>
261            <tr><td>McCabe modular design</td><td>           1</td></tr>
262          </table>
263         
264       
265        </div>
266       
267      </div>
268
269     
270
271      <div id="tagline">Produced by IDLdoc 2.0.</div>
272
273    </div>
274
275  </body>
276</html>
Note: See TracBrowser for help on using the repository browser.