source: trunk/SRC/Documentation/idldoc_html_output/Utilities/find.html @ 93

Last change on this file since 93 was 93, checked in by pinsard, 18 years ago

start to modify headers of Calendar and Utilities *.pro files for bet
ter idldoc output
File size: 9.4 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>find.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="find.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&nbsp;documentation</td>
67    </tr>
68  </table>
69
70</div>
71
72<div id="secondary_navbar">
73
74<a href="demomode_compatibility.html">&lt;&lt;prev file</a> | <a href="isadirectory.html">next file &gt;&gt;</a>&nbsp;&nbsp;&nbsp;&nbsp;<a href="find.html" target="_TOP">view single page</a> | <a href="./../index.html?format=raw" 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?format=raw">Utilities/</a></h1>
82      <h2 class="pro_file">find.pro</h2>
83
84      <div id="file_attr">
85        <dl>
86        </dl>
87      </div>
88
89      <div id="file_comments">  all file_search keywords can be used.
90</div>
91
92     
93
94     
95
96     
97
98     
99
100      <div id="routine_details">
101       
102
103        <div class="routine_details" id="_find">
104
105          <h2><a class="top" href="#container">top</a>find <span class="categories"> find a file
106</span></h2>
107       
108          <p class="header">
109            <span class="result">result = </span>find(<span class="result"><a href="#_find_param_filein">filein</a></span>, <a href="#_find_keyword_IODIRECTORY">IODIRECTORY</a>=<span class="result">IODIRECTORY</span>, <a href="#_find_keyword_RECURSIVE">RECURSIVE</a>=<span class="result">RECURSIVE</span>, <a href="#_find_keyword_REPERTOIRE">REPERTOIRE</a>=<span class="result">REPERTOIRE</span>, <a href="#_find_keyword_NOPRO">NOPRO</a>=<span class="result">NOPRO</span>, <a href="#_find_keyword_ONLYPRO">ONLYPRO</a>=<span class="result">ONLYPRO</span>, <a href="#_find_keyword_ONLYNC">ONLYNC</a>=<span class="result">ONLYNC</span>, <a href="#_find_keyword_UNIQUE">UNIQUE</a>=<span class="result">UNIQUE</span>, <a href="#_find_keyword_FIRSTFOUND">FIRSTFOUND</a>=<span class="result">FIRSTFOUND</span>, <a href="#_find_keyword_LOOKALLDIR">LOOKALLDIR</a>=<span class="result">LOOKALLDIR</span>, <a href="#_find_keyword__extra">_extra</a>=<span class="result">_extra</span>)</p>
110       
111          <div class="comments">
112 based on file_search, but it is possible to speficy
113          a set of possibles names and a different set of
114          possibles directories names.
115          By defaut look for files included in !path
116</div>
117
118          <h3>Return value</h3><div class="value"> A scalar or array variable of string type, containing the
119       name (with the full path of the matching files. If no files
120       exist with names matching the input arguments, find returns
121       the scalar string : 'NOT FOUND'
122</div>
123
124         
125            <h3>Parameters</h3>
126       
127           
128            <h4 id="_find_param_filein">filein&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
129              <span class="attr">in</span>
130             
131             
132              <span class="attr">required</span>
133             
134             
135             
136             
137            </h4>
138       
139          <div class="comments"> A scalar or array variable of string type, containing
140     file names to match. Input names specifications may contain
141     wildcard characters, enabling them to match multiple files
142     (see file_search for more informations). By defaut and if
143     necessary, find is looking for filename and also for filename
144     completed with '.pro'
145</div>
146           
147
148         
149
150         
151
152            <h3>Keywords</h3>
153           
154            <h4 id="_find_keyword_IODIRECTORY">IODIRECTORY&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
155             
156             
157             
158             
159             
160             
161             
162             
163            </h4>
164       
165            <div class="comments"> A scalar or array variable of string type, containing
166        directories names where we are looking for the file. by defaut
167        we use !path. Different directories can be separated by
168        path_sep(/search_path) (':' on unix type machine) as it is done
169        to define !path.
170        Note that if filename's dirname is different from '.', this
171        keyword is not taken into account.
172</div>
173           
174            <h4 id="_find_keyword_RECURSIVE">RECURSIVE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
175             
176             
177             
178             
179             
180             
181             
182             
183            </h4>
184       
185            <div class="comments"> performs recursive searching of directory hierarchies.
186        In a recursive search, find looks recursively for any and all
187        subdirectories in the file hierarchy rooted at the IODIRECTORY
188        argument.
189</div>
190           
191            <h4 id="_find_keyword_REPERTOIRE">REPERTOIRE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
192             
193             
194             
195             
196             
197             
198             
199             
200            </h4>
201       
202            <div class="comments"> obsolete. keep for compatibility, use directory keyword
203</div>
204           
205            <h4 id="_find_keyword_NOPRO">NOPRO&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
206             
207             
208             
209             
210             
211             
212             
213             
214            </h4>
215       
216            <div class="comments"> activate to avoid the automatic search of filename
217        completed with '.pro'
218</div>
219           
220            <h4 id="_find_keyword_ONLYPRO">ONLYPRO&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
221             
222             
223             
224             
225             
226             
227             
228             
229            </h4>
230       
231            <div class="comments"> force to look only at file ending with .pro
232</div>
233           
234            <h4 id="_find_keyword_ONLYNC">ONLYNC&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
235             
236             
237             
238             
239             
240             
241             
242             
243            </h4>
244       
245            <div class="comments"> force to look only at file ending with .nc
246</div>
247           
248            <h4 id="_find_keyword_UNIQUE">UNIQUE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
249             
250             
251             
252             
253             
254             
255             
256             
257            </h4>
258       
259            <div class="comments"> activate to make sure that each element of the output
260        vector is unique.
261</div>
262           
263            <h4 id="_find_keyword_FIRSTFOUND">FIRSTFOUND&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
264             
265             
266             
267             
268             
269             
270             
271             
272            </h4>
273       
274            <div class="comments"> activate this keyword to stop looking for the file as
275        soon as we found one.
276</div>
277           
278            <h4 id="_find_keyword_LOOKALLDIR">LOOKALLDIR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
279             
280             
281             
282             
283             
284             
285             
286             
287            </h4>
288       
289            <div class="comments"> activate to look for the file with a recursive search
290        in iodir, homedir, !path + the DATA:TestsData directory if it exists.
291</div>
292           
293            <h4 id="_find_keyword__extra">_extra&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
294             
295             
296             
297             
298             
299             
300             
301             
302            </h4>
303       
304            <div class="comments"></div>
305           
306         
307
308          <h3>Examples</h3><div class="value"> 
309
310   IDL> print, find('*loadct') 
311   /usr/local/rsi/idl_6.0/lib/utilities/xloadct.pro
312   /usr/local/rsi/idl_6.0/lib/loadct.pro
313   IDL> print, find('*loadct', iodir=!dir,/recursive)
314   /usr/local/rsi/idl_6.0/lib/loadct.pro
315   /usr/local/rsi/idl_6.0/lib/utilities/xloadct.pro
316   IDL> print, find('*loadct.pro') 
317   /usr/local/rsi/idl_6.0/lib/utilities/xloadct.pro
318   /usr/local/rsi/idl_6.0/lib/loadct.pro
319   IDL> print, find('*loadct',/nopro) 
320   NOT FOUND
321   IDL> print, find('*loadct', iodir = '/usr/local/rsi/idl_6.0/lib') 
322   /usr/local/rsi/idl_6.0/lib/loadct.pro
323   IDL> print, find('*loadct', iodir = '/usr/local/rsi/idl_6.0/lib', /test_write) 
324   NOT FOUND
325   IDL> print, find('*loadct', iodir = '/usr/local/rsi/idl_6.0/lib', /recursive) 
326   /usr/local/rsi/idl_6.0/lib/loadct.pro
327   /usr/local/rsi/idl_6.0/lib/utilities/xloadct.pro
328   IDL> print, find('mesh*', iodirectory = [iodir, !path])
329   /Users/sebastie/DATA/ORCA2/meshmaskORCA2closea.nc
330   /Users/sebastie/IDL/meshmaskclosesea.pro
331   /Users/sebastie/IDL/meshmaskclosesea.pro~
332   /Users/sebastie/SAXO_RD/Obsolete/meshlec.pro
333   /usr/local/rsi/idl_6.0/lib/mesh_obj.pro
334</div>
335          <h3>Version history</h3>
336         
337         
338          <h4>History</h4><div class="value"> Sebastien Masson (smasson@lodyc.jussieu.fr)
339                       28/4/1999
340                       6/7/1999: compatibilite mac et windows
341 June 2005: Sebastien Masson: cleaning, use for file_* functions</div>
342         
343         
344         
345         
346         
347         
348         
349       
350         
351         
352         
353         
354         
355         
356         
357       
358         
359       
360        </div>
361       
362      </div>
363
364     
365
366      <div id="tagline">Produced by IDLdoc 2.0.</div>
367
368    </div>
369
370  </body>
371</html>
Note: See TracBrowser for help on using the repository browser.