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>getfile.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="getfile.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//getfile.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 documentation</td> |
---|
67 | </tr> |
---|
68 | </table> |
---|
69 | |
---|
70 | </div> |
---|
71 | |
---|
72 | <div id="secondary_navbar"> |
---|
73 | |
---|
74 | <a href="delchr.html"><<prev file</a> | <a href="getwrd.html">next file >></a> <a href="getfile.html" target="_TOP">view single page</a> | <a href="./../../index.html" target="_TOP">view frames</a> summary: fields | routine 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">getfile.pro</h2> |
---|
83 | |
---|
84 | <div id="file_attr"> |
---|
85 | <dl> |
---|
86 | </dl> |
---|
87 | </div> |
---|
88 | |
---|
89 | <div id="file_comments"> |
---|
90 | Read a text file into a string array. |
---|
91 | </div> |
---|
92 | |
---|
93 | |
---|
94 | |
---|
95 | |
---|
96 | |
---|
97 | |
---|
98 | |
---|
99 | |
---|
100 | |
---|
101 | <div id="routine_details"> |
---|
102 | |
---|
103 | |
---|
104 | <div class="routine_details" id="_getfile"> |
---|
105 | |
---|
106 | <h2><a class="top" href="#container">top</a>getfile </h2> |
---|
107 | |
---|
108 | <p class="header"> |
---|
109 | <span class="result">result = </span>getfile(<span class="result"><a href="#_getfile_param_filein">filein</a></span>, <a href="#_getfile_keyword_error">error</a>=<span class="result">error</span>, <a href="#_getfile_keyword_help">help</a>=<span class="result">help</span>, <a href="#_getfile_keyword_quiet">quiet</a>=<span class="result">quiet</span>, <a href="#_getfile_keyword_lines">lines</a>=<span class="result">lines</span>, <a href="#_getfile_keyword_find">find</a>=<span class="result">find</span>)</p> |
---|
110 | |
---|
111 | <div class="comments"> |
---|
112 | </div> |
---|
113 | |
---|
114 | <h3>Return value</h3><div class="preformat"> |
---|
115 | </div> |
---|
116 | |
---|
117 | |
---|
118 | <h3>Parameters</h3> |
---|
119 | |
---|
120 | |
---|
121 | <h4 id="_getfile_param_filein">filein |
---|
122 | <span class="attr">in</span> |
---|
123 | |
---|
124 | |
---|
125 | <span class="attr">required</span> |
---|
126 | |
---|
127 | |
---|
128 | |
---|
129 | |
---|
130 | </h4> |
---|
131 | |
---|
132 | <div class="comments"> |
---|
133 | text file name. |
---|
134 | </div> |
---|
135 | |
---|
136 | |
---|
137 | |
---|
138 | |
---|
139 | |
---|
140 | |
---|
141 | <h3>Keywords</h3> |
---|
142 | |
---|
143 | <h4 id="_getfile_keyword_error">error |
---|
144 | |
---|
145 | |
---|
146 | |
---|
147 | |
---|
148 | |
---|
149 | |
---|
150 | |
---|
151 | |
---|
152 | </h4> |
---|
153 | |
---|
154 | <div class="comments"> |
---|
155 | =err error flag: 0=ok, 1=file not opened, |
---|
156 | 2=no lines in file. |
---|
157 | </div> |
---|
158 | |
---|
159 | <h4 id="_getfile_keyword_help">help |
---|
160 | |
---|
161 | |
---|
162 | |
---|
163 | |
---|
164 | |
---|
165 | |
---|
166 | |
---|
167 | |
---|
168 | </h4> |
---|
169 | |
---|
170 | <div class="comments"> |
---|
171 | </div> |
---|
172 | |
---|
173 | <h4 id="_getfile_keyword_quiet">quiet |
---|
174 | |
---|
175 | |
---|
176 | |
---|
177 | |
---|
178 | |
---|
179 | |
---|
180 | |
---|
181 | |
---|
182 | </h4> |
---|
183 | |
---|
184 | <div class="comments"> |
---|
185 | means give no error message. |
---|
186 | </div> |
---|
187 | |
---|
188 | <h4 id="_getfile_keyword_lines">lines |
---|
189 | |
---|
190 | |
---|
191 | |
---|
192 | |
---|
193 | |
---|
194 | |
---|
195 | |
---|
196 | |
---|
197 | </h4> |
---|
198 | |
---|
199 | <div class="comments"> |
---|
200 | =n Number of lines to read (def=all). |
---|
201 | Much faster if number of lines is known. |
---|
202 | Automatic for IDL 5.6 or later. |
---|
203 | </div> |
---|
204 | |
---|
205 | <h4 id="_getfile_keyword_find">find |
---|
206 | |
---|
207 | |
---|
208 | |
---|
209 | |
---|
210 | |
---|
211 | |
---|
212 | |
---|
213 | |
---|
214 | </h4> |
---|
215 | |
---|
216 | <div class="comments"> |
---|
217 | search the file in the all !path directories (use |
---|
218 | find.pro) |
---|
219 | </div> |
---|
220 | |
---|
221 | |
---|
222 | |
---|
223 | |
---|
224 | <h3>Version history</h3> |
---|
225 | |
---|
226 | <h4>Version</h4><div class="preformat"> |
---|
227 | $Id: getfile.pro 232 2007-03-20 16:59:36Z pinsard $ |
---|
228 | </div> |
---|
229 | <h4>History</h4><div class="preformat"> |
---|
230 | R. Sterner, 20 Mar, 1990 |
---|
231 | R. Sterner, 1999 Apr 14 --- Added LINES=n keyword. |
---|
232 | R. Sterner, 2003 Aug 29 --- Automatic lines if IDL 5.6+. |
---|
233 | R. Sterner, 2003 Sep 02 --- Check if file exists first. |
---|
234 | R. Sterner, 2003 Sep 04 --- Fixed error in number of lines in file. |
---|
235 | R. Sterner, 2003 Oct 10 --- Fixed error when no lines. |
---|
236 | R. Sterner, 2004 Jan 27 --- Fixed to work in IDL as old as vers 4. |
---|
237 | |
---|
238 | S. Masson (smasson@lodyc.jussieu.fr) 4 Feb 2002 |
---|
239 | search te file in the all !path directories (use find.pro) |
---|
240 | when using /find keyword. Use spawn, 'cat...' for unix os. |
---|
241 | |
---|
242 | Copyright (C) 1990, Johns Hopkins University/Applied Physics Laboratory |
---|
243 | This software may be used, copied, or redistributed as long as it is not |
---|
244 | sold and this copyright notice is reproduced on each copy made. This |
---|
245 | routine is provided as is without any express or implied warranties |
---|
246 | whatsoever. Other limitations apply as described in the file disclaimer.txt. |
---|
247 | </div> |
---|
248 | |
---|
249 | |
---|
250 | |
---|
251 | |
---|
252 | |
---|
253 | |
---|
254 | |
---|
255 | |
---|
256 | |
---|
257 | |
---|
258 | |
---|
259 | |
---|
260 | |
---|
261 | |
---|
262 | |
---|
263 | |
---|
264 | <h3>Statistics</h3> |
---|
265 | <table class="statistics"> |
---|
266 | <tr><td>McCabe cyclic</td><td> 17</td></tr> |
---|
267 | <tr><td>McCabe essential</td><td> 1</td></tr> |
---|
268 | <tr><td>McCabe modular design</td><td> 1</td></tr> |
---|
269 | </table> |
---|
270 | |
---|
271 | |
---|
272 | </div> |
---|
273 | |
---|
274 | </div> |
---|
275 | |
---|
276 | |
---|
277 | |
---|
278 | <div id="tagline">Produced by IDLdoc 2.0.</div> |
---|
279 | |
---|
280 | </div> |
---|
281 | |
---|
282 | </body> |
---|
283 | </html> |
---|