source: trunk/SRC/Documentation/idldoc_assistant_output/Textoidl/str_token.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.9 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>str_token.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="showtex.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="strcnt.html"><img src="./../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">Textoidl/</font></h1>
58    <h2>str_token.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64
65   
66
67     
68      <a name="#_str_token"></a>
69
70      <h2>str_token  </h2>
71
72      <p><font face="Courier"><i>result = </i>str_token(<i><a href="#_str_token_keyword_string">string</a>, <a href="#_str_token_keyword_token">token</a></i>, <a href="#_str_token_keyword_TRIM">TRIM</a>=<i>TRIM</i>, <a href="#_str_token_keyword_HELP">HELP</a>=<i>HELP</i>)</font></p>
73
74   
75 NAME:
76       STR_TOKEN
77 PURPOSE:
78       Retrieve portion of string up to token.
79 CATEGORY:
80       text/strings
81 CALLING SEQUENCE:
82       new = str_token( old, token )
83 INPUTS:
84       old   -- String to be split.  Contains text after    in, out
85                token on output.
86       token -- Token to use in splitting old.              in
87 KEYWORD PARAMETERS:
88       /TRIM -- set to remove leading blanks from old
89                before returning.
90       /HELP -- print useful message and exit.
91 OUTPUTS:
92       new   -- portion of string up to token.              out
93       old   -- portion of old after token.                 out, in
94 COMMON BLOCKS:
95 SIDE EFFECTS:
96       Input parameter old is modified.
97 NOTES:
98       Token may be one or more characters.
99       If token is not found, returns old and sets old to ''.
100 EXAMPLE:
101       If old is 'foo44 bar', then str_token( old, '44' ) would return
102       'foo', and upon return, old will be left with ' bar'.  If /TRIM
103       were set, old would be 'bar' on return.
104
105       If old='xyz', then new=str_token(old,'a') would return with
106       new='xyz' and old=''.
107 THANKS:
108       To D. Linder who wrote GETTOK, part of the goddard library,
109       upon which this is based.
110 MODIFICATION HISTORY:
111       $Id: str_token.pro 134 2006-07-07 10:19:08Z navarro $
112       $Log: str_token.pro,v $
113       Revision 1.1  2000/06/14 19:09:22  mcraig
114       Changed name of strtok str_token to avoid conflict in IDL 5.3.
115
116       Revision 1.3  1996/06/14 20:00:27  mcraig
117       Updated Copyright info.
118
119       Revision 1.2  1996/05/09 00:22:17  mcraig
120       Added built in help.
121
122       Revision 1.1  1996/01/31 18:47:37  mcraig
123       Initial revision
124
125 RELEASE:
126       $Name: Rel_2_1_2 $
127
128 COPYRIGHT:
129  Copyright (C) 1996 The Regents of the University of California, All
130  Rights Reserved.  Written by Matthew W. Craig.
131  See the file COPYRIGHT for restrictions on distrubting this code.
132  This code comes with absolutely NO warranty; see DISCLAIMER for details.
133
134   
135
136   
137    <h3>Parameters</h3>
138   
139
140    <a name="#_str_token_keyword_string"></a>
141    <h4>string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
142     
143     
144     
145     
146     
147     
148     
149     
150    </h4>
151
152   
153   
154
155    <a name="#_str_token_keyword_token"></a>
156    <h4>token&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
157     
158     
159     
160     
161     
162     
163     
164     
165    </h4>
166
167   
168   
169   
170
171   
172    <h3>Keywords</h3>
173
174   
175    <a name="#_str_token_keyword_TRIM"></a>
176    <h4>TRIM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
177     
178     
179     
180     
181     
182     
183     
184     
185    </h4>
186
187   
188   
189    <a name="#_str_token_keyword_HELP"></a>
190    <h4>HELP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
191     
192     
193     
194     
195     
196     
197     
198     
199    </h4>
200
201   
202   
203   
204
205   
206   
207   
208   
209   
210   
211
212   
213   
214   
215   
216   
217
218   
219   
220   
221   
222   
223   
224   
225
226    <font size="-3"><p>&nbsp;</p></font>
227    <hr size="1" color="#CCCCCC"/>
228     
229
230   
231
232    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0 on Tue Aug 29 14:49:47 2006.</font></p>
233
234  </body>
235</html>
Note: See TracBrowser for help on using the repository browser.