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

Last change on this file since 402 was 402, checked in by smasson, 15 years ago

update documentation
File size: 5.0 KB
RevLine 
[163]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%">
[195]48<a href="strsed.html"><img src="./../../prev.gif" border="0" alt="Previous"></a></td>
[163]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
[234]66
[163]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   
[187]103 String to be split. Contains text after in, out token on output.
[234]104
[163]105   
106
107    <a name="#_strtok_keyword_token"></a>
108    <h4>token&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
109      <font size="-1" color="#006633">in</font>
110     
111     
112      <font size="-1" color="#006633">required</font>
113     
114     
115     
116     
117    </h4>
118
119   
[234]120 Token to use in splitting old.
[163]121
122   
123   
124
125   
126    <h3>Keywords</h3>
127
128   
129    <a name="#_strtok_keyword_TRIM"></a>
130    <h4>TRIM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
131     
132     
133     
134     
135     
136     
137     
138     
139    </h4>
140
[234]141   
[187]142 set to remove leading blanks from old before returning.
[163]143
144   
145    <a name="#_strtok_keyword_HELP"></a>
146    <h4>HELP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
147     
148     
149     
150     
151     
152     
153     
154     
155    </h4>
156
157   
158 print useful message and exit.
[234]159
[163]160   
161   
162
[234]163    <h3>Examples</h3><pre>
[402]164 If old is 'foo44 bar', then strtok( old, '44' ) would return
165 'foo', and upon return, old will be left with ' bar'.  If /TRIM
166 were set, old would be 'bar' on return.
[163]167
[402]168 not ok ++
169   IDL> old='foo44 bar'
170   IDL> res=strtok( old, '44' )
171   IDL> print,res
172       0           5
173   IDL> print,old
174      foo44 bar
[163]175
[402]176   IDL> old='foo44 bar'
177   IDL> res=strtok( old, '44',/TRIM )
178   IDL> print,res
179       0           5
180   IDL> print,old
181      foo44 bar
182
183 not ok ++
184 If old='xyz', then new=strtok(old,'a') would return with
185 new='xyz' and old=''.
186   IDL> old='xyz'
187   IDL> new=strtok( old, 'a' )
188   IDL> print,new
189           0
190   IDL> print,old
191   xyz
192
193
[234]194    </pre><h3>Version history</h3>
[163]195   
196    <h4>Version</h4>
[402]197 $Id: strtok.pro 374 2008-08-08 15:12:27Z pinsard $
[163]198
199    <h4>History</h4>
200       $Log: strtok.pro,v $
201       Revision 1.3  1996/06/14 20:00:27  mcraig
202       Updated Copyright info.
203
204       Revision 1.2  1996/05/09 00:22:17  mcraig
205       Added built in help.
206
207       Revision 1.1  1996/01/31 18:47:37  mcraig
208       Initial revision
209
210 Thanks:
211       To D. Linder who wrote GETTOK, part of the goddard library,
212       upon which this is based.
213
214 Release:
215       $Name: Rel_1_2 $
216
217 Copyright:
218  Copyright (C) 1996 The Regents of the University of California, All
219  Rights Reserved.  Written by Matthew W. Craig.
[234]220  See the file COPYRIGHT for restrictions on distributing this code.
[163]221  This code comes with absolutely NO warranty; see DISCLAIMER for details.
222
223   
224
225    <h3>Known issues</h3>
226   
227   
228   
229    <h4>Restrictions</h4>
230 Input parameter old is modified.
231 Token may be one or more characters.
232 if token is not found, returns old and sets old to ''.
233
[234]234
[163]235   
236   
237   
238   
239   
240   
241   
242
243    <font size="-3"><p>&nbsp;</p></font>
244    <hr size="1" color="#CCCCCC"/>
245     
246
247   
248
[187]249    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
[163]250
251  </body>
[249]252</html>
Note: See TracBrowser for help on using the repository browser.