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>isafile.pro (IDLdoc API 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="isafile.pro (IDLdoc API documentation)"; |
---|
19 | } |
---|
20 | </script> |
---|
21 | </head> |
---|
22 | |
---|
23 | <body onload="setTitle();"> |
---|
24 | |
---|
25 | <div id="navbar_title"> |
---|
26 | <h1>IDLdoc API 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?format=raw" title="Overview of library">Overview</a></td> |
---|
36 | |
---|
37 | |
---|
38 | |
---|
39 | <td >Directory</td> |
---|
40 | |
---|
41 | |
---|
42 | |
---|
43 | <td><a href="./../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td> |
---|
44 | |
---|
45 | |
---|
46 | |
---|
47 | <td><a href="./../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td> |
---|
48 | |
---|
49 | |
---|
50 | |
---|
51 | <td><a href="./../search-page.html?format=raw" title="Search library">Search</a></td> |
---|
52 | |
---|
53 | |
---|
54 | <td id="selected">File</td> |
---|
55 | |
---|
56 | |
---|
57 | <td >Source</td> |
---|
58 | |
---|
59 | |
---|
60 | |
---|
61 | <td><a href="./../idldoc-help.html?format=raw" 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="isadirectory.html"><<prev file</a> | <a href="protype.html">next file >></a> <a href="isafile.html" target="_TOP">view single page</a> | <a href="./../index.html?format=raw" 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?format=raw">Utilities/</a></h1> |
---|
82 | <h2 class="pro_file">isafile.pro</h2> |
---|
83 | |
---|
84 | <div id="file_attr"> |
---|
85 | <dl> |
---|
86 | </dl> |
---|
87 | </div> |
---|
88 | |
---|
89 | <div id="file_comments"> all find, file_search and dialog_pickfile keywords (like title) |
---|
90 | can be used |
---|
91 | </div> |
---|
92 | |
---|
93 | |
---|
94 | |
---|
95 | |
---|
96 | |
---|
97 | |
---|
98 | |
---|
99 | |
---|
100 | |
---|
101 | <div id="routine_details"> |
---|
102 | |
---|
103 | |
---|
104 | <div class="routine_details" id="_isafile"> |
---|
105 | |
---|
106 | <h2><a class="top" href="#container">top</a>isafile <span class="categories"> io |
---|
107 | |
---|
108 | </span></h2> |
---|
109 | |
---|
110 | <p class="header"> |
---|
111 | <span class="result">result = </span>isafile(<span class="result">[<a href="#_isafile_param_filein">filein</a>]</span>, <a href="#_isafile_keyword_FILENAME">FILENAME</a>=<span class="result">FILENAME</span>, <a href="#_isafile_keyword_IODIRECTORY">IODIRECTORY</a>=<span class="result">IODIRECTORY</span>, <a href="#_isafile_keyword_NEW">NEW</a>=<span class="result">NEW</span>, <a href="#_isafile_keyword_RECURSIVE">RECURSIVE</a>=<span class="result">RECURSIVE</span>, <a href="#_isafile_keyword_ONLYPRO">ONLYPRO</a>=<span class="result">ONLYPRO</span>, <a href="#_isafile_keyword_ONLYNC">ONLYNC</a>=<span class="result">ONLYNC</span>, <a href="#_isafile_keyword__extra">_extra</a>=<span class="result">_extra</span>)</p> |
---|
112 | |
---|
113 | <div class="comments"> |
---|
114 | same as find.pro except that as long as the file is 'NOT FOUND', |
---|
115 | isafile calls dialog_pickfile, to ask the user to select a file. |
---|
116 | </div> |
---|
117 | |
---|
118 | <h3>Return value</h3><div class="value"> the filename with its path |
---|
119 | </div> |
---|
120 | |
---|
121 | |
---|
122 | <h3>Parameters</h3> |
---|
123 | |
---|
124 | |
---|
125 | <h4 id="_isafile_param_filein">filein |
---|
126 | <span class="attr">in</span> |
---|
127 | |
---|
128 | <span class="attr">optional</span> |
---|
129 | |
---|
130 | |
---|
131 | |
---|
132 | |
---|
133 | |
---|
134 | </h4> |
---|
135 | |
---|
136 | <div class="comments"> a proposed name. If neither filein |
---|
137 | input parameter of filename keyword are defined, |
---|
138 | the ask the user to choose a file. |
---|
139 | </div> |
---|
140 | |
---|
141 | |
---|
142 | |
---|
143 | |
---|
144 | |
---|
145 | |
---|
146 | <h3>Keywords</h3> |
---|
147 | |
---|
148 | <h4 id="_isafile_keyword_FILENAME">FILENAME |
---|
149 | |
---|
150 | |
---|
151 | |
---|
152 | |
---|
153 | |
---|
154 | |
---|
155 | |
---|
156 | |
---|
157 | </h4> |
---|
158 | |
---|
159 | <div class="comments"> a proposed filename. |
---|
160 | </div> |
---|
161 | |
---|
162 | <h4 id="_isafile_keyword_IODIRECTORY">IODIRECTORY |
---|
163 | |
---|
164 | |
---|
165 | |
---|
166 | |
---|
167 | |
---|
168 | |
---|
169 | |
---|
170 | |
---|
171 | </h4> |
---|
172 | |
---|
173 | <div class="comments"> a directory where we look for the file. this |
---|
174 | keyword is taken into account only if the dirmame |
---|
175 | of filein or filename is '.' |
---|
176 | </div> |
---|
177 | |
---|
178 | <h4 id="_isafile_keyword_NEW">NEW |
---|
179 | |
---|
180 | |
---|
181 | |
---|
182 | |
---|
183 | |
---|
184 | |
---|
185 | |
---|
186 | |
---|
187 | </h4> |
---|
188 | |
---|
189 | <div class="comments"> to specify that filename is a new file and that |
---|
190 | we should check only its path |
---|
191 | </div> |
---|
192 | |
---|
193 | <h4 id="_isafile_keyword_RECURSIVE">RECURSIVE |
---|
194 | |
---|
195 | |
---|
196 | |
---|
197 | |
---|
198 | |
---|
199 | |
---|
200 | |
---|
201 | |
---|
202 | </h4> |
---|
203 | |
---|
204 | <div class="comments"> performs recursive searching of directory hierarchies. |
---|
205 | In a recursive search, find looks recursively for any and all |
---|
206 | subdirectories in the file hierarchy rooted at the IODIRECTORY |
---|
207 | argument. |
---|
208 | </div> |
---|
209 | |
---|
210 | <h4 id="_isafile_keyword_ONLYPRO">ONLYPRO |
---|
211 | |
---|
212 | |
---|
213 | |
---|
214 | |
---|
215 | |
---|
216 | |
---|
217 | |
---|
218 | |
---|
219 | </h4> |
---|
220 | |
---|
221 | <div class="comments"> force to look only at file ending with .pro |
---|
222 | </div> |
---|
223 | |
---|
224 | <h4 id="_isafile_keyword_ONLYNC">ONLYNC |
---|
225 | |
---|
226 | |
---|
227 | |
---|
228 | |
---|
229 | |
---|
230 | |
---|
231 | |
---|
232 | |
---|
233 | </h4> |
---|
234 | |
---|
235 | <div class="comments"> force to look only at file ending with .nc |
---|
236 | </div> |
---|
237 | |
---|
238 | <h4 id="_isafile_keyword__extra">_extra |
---|
239 | |
---|
240 | |
---|
241 | |
---|
242 | |
---|
243 | |
---|
244 | |
---|
245 | |
---|
246 | |
---|
247 | </h4> |
---|
248 | |
---|
249 | <div class="comments"></div> |
---|
250 | |
---|
251 | |
---|
252 | |
---|
253 | <h3>Examples</h3><div class="value"> |
---|
254 | |
---|
255 | IDL> print, isafile('/Users/sebastie/SAXO_RD/Commons/cm_4mesh.pro') |
---|
256 | /Users/sebastie/SAXO_RD/Commons/cm_4mesh.pro |
---|
257 | IDL> print, isafile('cm_4mesh.pro', iodir = '/Users/sebastie/SAXO_RD/Commons') |
---|
258 | /Users/sebastie/SAXO_RD/Commons/cm_4mesh.pro |
---|
259 | IDL> print, isafile('cm_4mesh.pro', iodir = !path) |
---|
260 | /Users/sebastie/SAXO_RD/Commons/cm_4mesh.pro |
---|
261 | IDL> print, isafile('cm_4mesh.pro', iodir = '/Users/sebastie/SAXO_RD', /recursive) |
---|
262 | /Users/sebastie/SAXO_RD/Commons/cm_4mesh.pro |
---|
263 | IDL> print, isafile('cm_4mesh.pro', iodir = getenv('HOME'), /recursive) |
---|
264 | /Users/sebastie/SAXO_RD/Commons/cm_4mesh.pro |
---|
265 | IDL> print, isafile('fake_file.pro') |
---|
266 | </div> |
---|
267 | <h3>Version history</h3> |
---|
268 | |
---|
269 | |
---|
270 | <h4>History</h4><div class="value"> Sebastien Masson (smasson@lodyc.jussieu.fr) |
---|
271 | 11/2/2000 |
---|
272 | June 2005: Sebastien Masson: cleaning, use for file_* functions</div> |
---|
273 | |
---|
274 | |
---|
275 | |
---|
276 | |
---|
277 | |
---|
278 | |
---|
279 | |
---|
280 | |
---|
281 | |
---|
282 | |
---|
283 | |
---|
284 | |
---|
285 | |
---|
286 | |
---|
287 | |
---|
288 | |
---|
289 | |
---|
290 | |
---|
291 | </div> |
---|
292 | |
---|
293 | </div> |
---|
294 | |
---|
295 | |
---|
296 | |
---|
297 | <div id="tagline">Produced by IDLdoc 2.0.</div> |
---|
298 | |
---|
299 | </div> |
---|
300 | |
---|
301 | </body> |
---|
302 | </html> |
---|