source: trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/STRING/strtok.html @ 163

Last change on this file since 163 was 163, checked in by navarro, 18 years ago

header improvements : type of parameters and keywords, default values, spell checking + idldoc assistant (IDL online_help)
File size: 4.7 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>strtok.pro (SAXO Documentation Assistant)</title>
6  </head>
7
8  <body text="#000000" bgcolor="#FFFFFF">
9
10   
11<!-- Navbar template takes a structure with the following fields:
12       overview_href :
13       overview_selected :
14       dir_overview_href :
15       dir_overview_selected :
16       categories_href :
17       categories_selected :
18       index_href :
19       index_selected :
20       search_href :
21       search_selected :
22       file_selected :
23       source_href :
24       source_selected :
25       help_href :
26       help_selected :
27       etc_selected :
28
29       prev_file_href :
30       next_file_href :
31
32       view_single_page_href :
33       view_frames_href :
34
35       summary_fields_href :
36       summary_routine_href :
37       details_routine_href :
38
39       title :
40       subtitle :
41       user :
42-->
43
44
45<table border="0" cellpadding="0" cellspacing="0" width="98%" bgcolor="#F0F0FF" valign="bottom">
46  <tr>
47    <td width="10%">
48<a href="strsci.html"><img src="./../../prev.gif" border="0" alt="Previous"></a></td>
49    <td width="80%" align="center" valign="center">
50<font size=-1><i>SAXO Documentation Assistant</i>: <a href="./../../home.html">Overview</a></font></td>
51    <td width="10%" align="right">
52<a href="strwhere.html"><img src="./../../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">ToBeReviewed/STRING/</font></h1>
58    <h2>strtok.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 Retrieve portion of string up to token.
65 
66
67   
68
69     
70      <a name="#_strtok"></a>
71
72      <h2>strtok  <font size="-1" color="#006633">
73 String
74</font></h2>
75
76      <p><font face="Courier"><i>result = </i>strtok(<i><a href="#_strtok_keyword_string">string</a>, <a href="#_strtok_keyword_token">token</a></i>, <a href="#_strtok_keyword_TRIM">TRIM</a>=<i>TRIM</i>, <a href="#_strtok_keyword_HELP">HELP</a>=<i>HELP</i>)</font></p>
77
78   
79
80
81    <h3>Return value</h3>
82 new   -- portion of string up to token.              out
83 old   -- portion of old after token.                 out, in
84
85
86   
87    <h3>Parameters</h3>
88   
89
90    <a name="#_strtok_keyword_string"></a>
91    <h4>string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
92      <font size="-1" color="#006633">in</font>
93     
94     
95      <font size="-1" color="#006633">required</font>
96     
97     
98     
99     
100    </h4>
101
102   
103 String to be split.  Contains text after    in, out
104 token on output.
105 
106   
107
108    <a name="#_strtok_keyword_token"></a>
109    <h4>token&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
110      <font size="-1" color="#006633">in</font>
111     
112     
113      <font size="-1" color="#006633">required</font>
114     
115     
116     
117     
118    </h4>
119
120   
121 Token to use in splitting old.       
122
123   
124   
125
126   
127    <h3>Keywords</h3>
128
129   
130    <a name="#_strtok_keyword_TRIM"></a>
131    <h4>TRIM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
132     
133     
134     
135     
136     
137     
138     
139     
140    </h4>
141
142     
143 set to remove leading blanks from old
144 before returning.
145
146   
147    <a name="#_strtok_keyword_HELP"></a>
148    <h4>HELP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
149     
150     
151     
152     
153     
154     
155     
156     
157    </h4>
158
159   
160 print useful message and exit.
161 
162   
163   
164
165    <h3>Examples</h3>
166       If old is 'foo44 bar', then strtok( old, '44' ) would return
167       'foo', and upon return, old will be left with ' bar'.  If /TRIM
168       were set, old would be 'bar' on return.
169
170       If old='xyz', then new=strtok(old,'a') would return with
171       new='xyz' and old=''.
172
173    <h3>Version history</h3>
174   
175    <h4>Version</h4>
176 $Id: strtok.pro 157 2006-08-21 09:01:50Z navarro $
177
178    <h4>History</h4>
179       $Log: strtok.pro,v $
180       Revision 1.3  1996/06/14 20:00:27  mcraig
181       Updated Copyright info.
182
183       Revision 1.2  1996/05/09 00:22:17  mcraig
184       Added built in help.
185
186       Revision 1.1  1996/01/31 18:47:37  mcraig
187       Initial revision
188
189 Thanks:
190       To D. Linder who wrote GETTOK, part of the goddard library,
191       upon which this is based.
192
193 Release:
194       $Name: Rel_1_2 $
195
196 Copyright:
197  Copyright (C) 1996 The Regents of the University of California, All
198  Rights Reserved.  Written by Matthew W. Craig.
199  See the file COPYRIGHT for restrictions on distrubting this code.
200  This code comes with absolutely NO warranty; see DISCLAIMER for details.
201
202   
203
204    <h3>Known issues</h3>
205   
206   
207   
208    <h4>Restrictions</h4>
209 Input parameter old is modified.
210 Token may be one or more characters.
211 if token is not found, returns old and sets old to ''.
212 
213
214   
215   
216   
217   
218   
219   
220   
221
222    <font size="-3"><p>&nbsp;</p></font>
223    <hr size="1" color="#CCCCCC"/>
224     
225
226   
227
228    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0 on Tue Aug 29 14:50:32 2006.</font></p>
229
230  </body>
231</html>
Note: See TracBrowser for help on using the repository browser.