source: trunk/SRC/Documentation/idldoc_assistant_output/ToBeReviewed/STRING/getfile.html @ 200

Last change on this file since 200 was 200, checked in by smasson, 18 years ago

update idldoc documentation
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>getfile.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="delchr.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="getwrd.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>getfile.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 Read a text file into a string array.
65
66
67   
68
69     
70      <a name="#_getfile"></a>
71
72      <h2>getfile  </h2>
73
74      <p><font face="Courier"><i>result = </i>getfile(<i><a href="#_getfile_keyword_filein">filein</a></i>, <a href="#_getfile_keyword_error">error</a>=<i>error</i>, <a href="#_getfile_keyword_help">help</a>=<i>help</i>, <a href="#_getfile_keyword_quiet">quiet</a>=<i>quiet</i>, <a href="#_getfile_keyword_lines">lines</a>=<i>lines</i>, <a href="#_getfile_keyword_find">find</a>=<i>find</i>)</font></p>
75
76   
77
78
79    <h3>Return value</h3>
80 
81
82   
83    <h3>Parameters</h3>
84   
85
86    <a name="#_getfile_keyword_filein"></a>
87    <h4>filein&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
88      <font size="-1" color="#006633">in</font>
89     
90     
91      <font size="-1" color="#006633">required</font>
92     
93     
94     
95     
96    </h4>
97
98   
99 text file name.
100 
101   
102   
103
104   
105    <h3>Keywords</h3>
106
107   
108    <a name="#_getfile_keyword_error"></a>
109    <h4>error&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
110     
111     
112     
113     
114     
115     
116     
117     
118    </h4>
119
120   
121 =err  error flag: 0=ok, 1=file not opened,
122 2=no lines in file.
123         
124   
125    <a name="#_getfile_keyword_help"></a>
126    <h4>help&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
127     
128     
129     
130     
131     
132     
133     
134     
135    </h4>
136
137   
138 
139   
140    <a name="#_getfile_keyword_quiet"></a>
141    <h4>quiet&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
142     
143     
144     
145     
146     
147     
148     
149     
150    </h4>
151
152     
153 means give no error message.
154         
155   
156    <a name="#_getfile_keyword_lines"></a>
157    <h4>lines&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
158     
159     
160     
161     
162     
163     
164     
165     
166    </h4>
167
168   
169 =n  Number of lines to read (def=all).
170 Much faster if number of lines is known.
171 Automatic for IDL 5.6 or later.
172         
173   
174    <a name="#_getfile_keyword_find"></a>
175    <h4>find&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
176     
177     
178     
179     
180     
181     
182     
183     
184    </h4>
185
186     
187 search the file in the all !path directories (use
188 find.pro)
189
190   
191   
192
193   
194    <h3>Version history</h3>
195   
196    <h4>Version</h4>
197 $Id: getfile.pro 192 2006-09-22 09:37:08Z smasson $
198
199    <h4>History</h4>
200       R. Sterner, 20 Mar, 1990
201       R. Sterner, 1999 Apr 14 --- Added LINES=n keyword.
202       R. Sterner, 2003 Aug 29 --- Automatic lines if IDL 5.6+.
203       R. Sterner, 2003 Sep 02 --- Check if file exists first.
204       R. Sterner, 2003 Sep 04 --- Fixed error in number of lines in file.
205       R. Sterner, 2003 Oct 10 --- Fixed error when no lines.
206       R. Sterner, 2004 Jan 27 --- Fixed to work in IDL as old as vers 4.
207
208       S. Masson (smasson@lodyc.jussieu.fr) 4 Feb 2002
209       search te file in the all !path directories (use find.pro)
210       when using /find keyword. Use spawn, 'cat...' for unix os.
211
212 Copyright (C) 1990, Johns Hopkins University/Applied Physics Laboratory
213 This software may be used, copied, or redistributed as long as it is not
214 sold and this copyright notice is reproduced on each copy made.  This
215 routine is provided as is without any express or implied warranties
216 whatsoever.  Other limitations apply as described in the file disclaimer.txt.
217
218   
219
220   
221   
222   
223   
224   
225
226   
227   
228   
229   
230   
231   
232   
233
234    <font size="-3"><p>&nbsp;</p></font>
235    <hr size="1" color="#CCCCCC"/>
236     
237
238   
239
240    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
241
242  </body>
243</html>
Note: See TracBrowser for help on using the repository browser.