source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/STRING/strtok.html @ 338

Last change on this file since 338 was 338, checked in by smasson, 16 years ago

update documentation
File size: 6.0 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>strtok.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="strtok.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="../../../../ToBeReviewed/STRING//strtok.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="strsed.html">&lt;&lt;prev file</a> | <a href="strwhere.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="strtok.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">ToBeReviewed/STRING/</a></h1>
82      <h2 class="pro_file">strtok.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">
90 Retrieve portion of string up to token.
91</div>
92
93     
94
95     
96
97     
98
99     
100
101      <div id="routine_details">
102       
103
104        <div class="routine_details" id="_strtok">
105
106          <h2><a class="top" href="#container">top</a>strtok <span class="categories">
107 String
108</span></h2>
109       
110          <p class="header">
111            <span class="result">result = </span>strtok(<span class="result"><a href="#_strtok_param_string">string</a>, <a href="#_strtok_param_token">token</a></span>, <a href="#_strtok_keyword_TRIM">TRIM</a>=<span class="result">TRIM</span>, <a href="#_strtok_keyword_HELP">HELP</a>=<span class="result">HELP</span>)</p>
112       
113          <div class="comments">
114</div>
115
116          <h3>Return value</h3><div class="preformat">
117 new   -- portion of string up to token.              out
118 old   -- portion of old after token.                 out, in
119</div>
120
121         
122            <h3>Parameters</h3>
123       
124           
125            <h4 id="_strtok_param_string">string&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
126              <span class="attr">in</span>
127             
128             
129              <span class="attr">required</span>
130             
131             
132             
133             
134            </h4>
135       
136          <div class="comments">
137 String to be split. Contains text after in, out token on output.
138</div>
139           
140            <h4 id="_strtok_param_token">token&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
141              <span class="attr">in</span>
142             
143             
144              <span class="attr">required</span>
145             
146             
147             
148             
149            </h4>
150       
151          <div class="comments">
152 Token to use in splitting old.
153</div>
154           
155
156         
157
158         
159
160            <h3>Keywords</h3>
161           
162            <h4 id="_strtok_keyword_TRIM">TRIM&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
163             
164             
165             
166             
167             
168             
169             
170             
171            </h4>
172       
173            <div class="comments">
174 set to remove leading blanks from old before returning.
175</div>
176           
177            <h4 id="_strtok_keyword_HELP">HELP&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
178             
179             
180             
181             
182             
183             
184             
185             
186            </h4>
187       
188            <div class="comments">
189 print useful message and exit.
190</div>
191           
192         
193
194          <h3>Examples</h3><div class="preformat">
195       If old is 'foo44 bar', then strtok( old, '44' ) would return
196       'foo', and upon return, old will be left with ' bar'.  If /TRIM
197       were set, old would be 'bar' on return.
198
199       If old='xyz', then new=strtok(old,'a') would return with
200       new='xyz' and old=''.
201</div>
202          <h3>Version history</h3>
203         
204          <h4>Version</h4><div class="preformat">
205 $Id: strtok.pro 325 2007-12-06 10:04:53Z pinsard $
206</div>
207          <h4>History</h4><div class="preformat">
208       $Log: strtok.pro,v $
209       Revision 1.3  1996/06/14 20:00:27  mcraig
210       Updated Copyright info.
211
212       Revision 1.2  1996/05/09 00:22:17  mcraig
213       Added built in help.
214
215       Revision 1.1  1996/01/31 18:47:37  mcraig
216       Initial revision
217
218 Thanks:
219       To D. Linder who wrote GETTOK, part of the goddard library,
220       upon which this is based.
221
222 Release:
223       $Name: Rel_1_2 $
224
225 Copyright:
226  Copyright (C) 1996 The Regents of the University of California, All
227  Rights Reserved.  Written by Matthew W. Craig.
228  See the file COPYRIGHT for restrictions on distributing this code.
229  This code comes with absolutely NO warranty; see DISCLAIMER for details.
230</div>
231         
232         
233          <h3>Known issues</h3>
234         
235         
236         
237          <h4>Restrictions</h4><div class="preformat">
238 Input parameter old is modified.
239 Token may be one or more characters.
240 if token is not found, returns old and sets old to ''.
241</div>
242       
243         
244         
245         
246         
247         
248         
249         
250       
251          <h3>Statistics</h3>
252          <table class="statistics">
253            <tr><td>McCabe cyclic</td><td>           4</td></tr>
254            <tr><td>McCabe essential</td><td>           1</td></tr>
255            <tr><td>McCabe modular design</td><td>           1</td></tr>
256          </table>
257         
258       
259        </div>
260       
261      </div>
262
263     
264
265      <div id="tagline">Produced by IDLdoc 2.0.</div>
266
267    </div>
268
269  </body>
270</html>
Note: See TracBrowser for help on using the repository browser.