source: trunk/SRC/Documentation/idldoc_html_output/Utilities/isafile.html

Last change on this file was 402, checked in by smasson, 15 years ago

update documentation
File size: 7.7 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>isafile.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="isafile.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="../../../Utilities//isafile.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="isadirectory.html">&lt;&lt;prev file</a> | <a href="linearequation.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="isafile.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">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">
90 same as <a href="..//Utilities/find.html">find</a> except that as long as the file is 'NOT FOUND',
91 <a href="..//Utilities/isafile.html">isafile</a> calls
92 <a href="/Applications/itt/idl64/help/online_help/DIALOG_PICKFILE.html">DIALOG_PICKFILE</a>, to ask the user to select a file.
93</div>
94
95     
96
97     
98
99     
100
101     
102
103      <div id="routine_details">
104       
105
106        <div class="routine_details" id="_isafile">
107
108          <h2><a class="top" href="#container">top</a>isafile <span class="categories">
109 Input/Output
110</span></h2>
111       
112          <p class="header">
113            <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>
114       
115          <div class="comments">
116</div>
117
118          <h3>Return value</h3><div class="preformat">
119 the filename with its path
120</div>
121
122         
123            <h3>Parameters</h3>
124       
125           
126            <h4 id="_isafile_param_filein">filein&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
127              <span class="attr">in</span>
128             
129              <span class="attr">optional</span>
130             
131             
132             
133             
134             
135            </h4>
136       
137          <div class="comments">
138 a proposed name. If neither filein input parameter or filename keyword are
139 defined, we ask the user to choose a file.
140</div>
141           
142
143         
144
145         
146
147            <h3>Keywords</h3>
148           
149            <h4 id="_isafile_keyword_FILENAME">FILENAME&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
150             
151             
152             
153             
154             
155             
156             
157             
158            </h4>
159       
160            <div class="comments">
161 a proposed filename.
162</div>
163           
164            <h4 id="_isafile_keyword_IODIRECTORY">IODIRECTORY&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
165             
166             
167             
168             
169             
170             
171             
172             
173            </h4>
174       
175            <div class="comments">
176 a directory where we look for the file. this
177 keyword is taken into account only if the dirname
178 of filein or filename is '.'
179</div>
180           
181            <h4 id="_isafile_keyword_NEW">NEW&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
182             
183             
184             
185             
186             
187             
188             
189             
190            </h4>
191       
192            <div class="comments">
193 to specify that filename is a new file and that we should check only its
194 path
195</div>
196           
197            <h4 id="_isafile_keyword_RECURSIVE">RECURSIVE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
198             
199             
200             
201             
202             
203             
204             
205             
206            </h4>
207       
208            <div class="comments">
209 performs recursive searching of directory hierarchies.
210 In a recursive search, <a href="..//Utilities/find.html">find</a> looks recursively for any and all
211 subdirectories in the file hierarchy rooted at the IODIRECTORY argument.
212</div>
213           
214            <h4 id="_isafile_keyword_ONLYPRO">ONLYPRO&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
215             
216             
217             
218             
219             
220             
221             
222             
223            </h4>
224       
225            <div class="comments">
226 force to look only at file ending with .pro
227</div>
228           
229            <h4 id="_isafile_keyword_ONLYNC">ONLYNC&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
230             
231             
232             
233             
234             
235             
236             
237             
238            </h4>
239       
240            <div class="comments">
241 force to look only at file ending with .nc
242</div>
243           
244            <h4 id="_isafile_keyword__EXTRA">_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
245             
246             
247             
248             
249             
250             
251             
252             
253            </h4>
254       
255            <div class="comments">
256 Used to pass keywords to <a href="..//Utilities/find.html">find</a>,
257 <a href="/Applications/itt/idl64/help/online_help/FILE_SEARCH.html">FILE_SEARCH</a> and
258 <a href="/Applications/itt/idl64/help/online_help/DIALOG_PICKFILE.html">DIALOG_PICKFILE</a>
259</div>
260           
261         
262
263          <h3>Examples</h3><div class="preformat">
264
265   IDL> print, isafile('/Users/sebastie/SAXO_RD/Commons/cm_4mesh.pro')
266  /Users/sebastie/SAXO_RD/Commons/cm_4mesh.pro
267   IDL> print, isafile('cm_4mesh.pro', iodir = '/Users/sebastie/SAXO_RD/Commons')
268  /Users/sebastie/SAXO_RD/Commons/cm_4mesh.pro
269   IDL> print, isafile('cm_4mesh.pro', iodir = !path)
270  /Users/sebastie/SAXO_RD/Commons/cm_4mesh.pro
271   IDL> print, isafile('cm_4mesh.pro', iodir = '/Users/sebastie/SAXO_RD', /recursive)
272  /Users/sebastie/SAXO_RD/Commons/cm_4mesh.pro
273   IDL> print, isafile('cm_4mesh.pro', iodir = getenv('HOME'), /recursive)
274  /Users/sebastie/SAXO_RD/Commons/cm_4mesh.pro
275   IDL> print, isafile('fake_file.pro')
276</div>
277          <h3>Version history</h3>
278         
279          <h4>Version</h4><div class="preformat">
280 $Id: isafile.pro 392 2009-02-10 09:34:16Z smasson $
281</div>
282          <h4>History</h4><div class="preformat">
283 Sebastien Masson (smasson@lodyc.jussieu.fr)
284                      11/2/2000
285 June 2005: Sebastien Masson: cleaning, use for file_* functions
286</div>
287         
288         
289         
290         
291         
292         
293         
294       
295         
296         
297         
298         
299         
300         
301         
302       
303          <h3>Statistics</h3>
304          <table class="statistics">
305            <tr><td>McCabe cyclic</td><td>          14</td></tr>
306            <tr><td>McCabe essential</td><td>           1</td></tr>
307            <tr><td>McCabe modular design</td><td>           1</td></tr>
308          </table>
309         
310       
311        </div>
312       
313      </div>
314
315     
316
317      <div id="tagline">Produced by IDLdoc 2.0.</div>
318
319    </div>
320
321  </body>
322</html>
Note: See TracBrowser for help on using the repository browser.