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

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

update documentation
File size: 5.0 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    </pre><h3>Version history</h3>
195   
196    <h4>Version</h4>
197 $Id: getfile.pro 358 2008-04-28 09:41:14Z pinsard $
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 the file in the all !path directories (use <a href="../..//Utilities/find.html">find</a>)
210       when using /find keyword. Use <a href="/Applications/itt/idl64/help/online_help/SPAWN.html">SPAWN</a>, 'cat...' for
211       unix os.
212
213 Copyright (C) 1990, Johns Hopkins University/Applied Physics Laboratory
214 This software may be used, copied, or redistributed as long as it is not
215 sold and this copyright notice is reproduced on each copy made.  This
216 routine is provided as is without any express or implied warranties
217 whatsoever.  Other limitations apply as described in the file disclaimer.txt.
218
219   
220
221   
222   
223   
224   
225   
226
227   
228   
229   
230   
231   
232   
233   
234
235    <font size="-3"><p>&nbsp;</p></font>
236    <hr size="1" color="#CCCCCC"/>
237     
238
239   
240
241    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
242
243  </body>
244</html>
Note: See TracBrowser for help on using the repository browser.