source: trunk/SRC/Documentation/idldoc_assistant_output/Utilities/find.html @ 234

Last change on this file since 234 was 234, checked in by pinsard, 17 years ago

new idldoc html and assistant outputs
File size: 8.6 KB
Line 
1
2
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4  <head>
5    <title>find.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="demomode_compatibility.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="fitintobox.html"><img src="./../next.gif" border="0" alt="Next"></a></td>
53  </tr>
54</table>
55
56
57    <h1><font size="-2">Utilities/</font></h1>
58    <h2>find.pro</h2>
59
60    <dl>
61    </dl>
62
63   
64 based on <proidl>file_search</proidl>, but it is possible to specify
65 a set of possibles names and a different set of
66 possibles directories names.
67 By default look for files included in !path
68
69 all file_search keywords can be used.
70
71
72   
73
74     
75      <a name="#_find"></a>
76
77      <h2>find  <font size="-1" color="#006633"> 
78 find a file
79</font></h2>
80
81      <p><font face="Courier"><i>result = </i>find(<i><a href="#_find_keyword_filein">filein</a></i>, <a href="#_find_keyword_IODIRECTORY">IODIRECTORY</a>=<i>IODIRECTORY</i>, <a href="#_find_keyword_RECURSIVE">RECURSIVE</a>=<i>RECURSIVE</i>, <a href="#_find_keyword_REPERTOIRE">REPERTOIRE</a>=<i>REPERTOIRE</i>, <a href="#_find_keyword_NOPRO">NOPRO</a>=<i>NOPRO</i>, <a href="#_find_keyword_ONLYPRO">ONLYPRO</a>=<i>ONLYPRO</i>, <a href="#_find_keyword_ONLYNC">ONLYNC</a>=<i>ONLYNC</i>, <a href="#_find_keyword_UNIQUE">UNIQUE</a>=<i>UNIQUE</i>, <a href="#_find_keyword_FIRSTFOUND">FIRSTFOUND</a>=<i>FIRSTFOUND</i>, <a href="#_find_keyword_LOOKALLDIR">LOOKALLDIR</a>=<i>LOOKALLDIR</i>, <a href="#_find_keyword_TRYFIND">TRYFIND</a>=<i>TRYFIND</i>, <a href="#_find_keyword__EXTRA">_EXTRA</a>=<i>_EXTRA</i>)</font></p>
82
83   
84
85
86    <h3>Return value</h3> 
87 A scalar or array variable of string type, containing the
88 name (with the full path of the matching files. If no files
89 exist with names matching the input arguments, find returns
90 the scalar string : 'NOT FOUND'
91
92
93   
94    <h3>Parameters</h3>
95   
96
97    <a name="#_find_keyword_filein"></a>
98    <h4>filein&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
99      <font size="-1" color="#006633">in</font>
100     
101     
102      <font size="-1" color="#006633">required</font>
103     
104     
105     
106     
107    </h4>
108
109     
110 A scalar or array variable of string type, containing
111 file names to match. Input names specifications may contain
112 wildcard characters, enabling them to match multiple files
113 (see file_search for more informations). By default and if
114 necessary, find is looking for filename and also for filename
115 completed with '.pro'
116
117   
118   
119
120   
121    <h3>Keywords</h3>
122
123   
124    <a name="#_find_keyword_IODIRECTORY"></a>
125    <h4>IODIRECTORY&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
126     
127     
128     
129     
130     
131     
132      <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>['.',!path]</i></font>
133     
134    </h4>
135
136     
137 A scalar or array variable of string type, containing
138 directories names where we are looking for the file.
139 Different directories can be separated by
140 path_sep(/search_path) (':' on unix type machine) as it is done
141 to define !path.
142 Note that if filename's dirname is different from '.', this
143 keyword is not taken into account.
144
145   
146    <a name="#_find_keyword_RECURSIVE"></a>
147    <h4>RECURSIVE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
148     
149     
150     
151     
152     
153     
154     
155     
156    </h4>
157
158     
159 performs recursive searching of directory hierarchies.
160 In a recursive search, find looks recursively for any and all
161 subdirectories in the file hierarchy rooted at the IODIRECTORY argument.
162
163   
164    <a name="#_find_keyword_REPERTOIRE"></a>
165    <h4>REPERTOIRE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
166     
167     
168     
169     
170     
171     
172     
173     
174    </h4>
175
176     
177 obsolete. keep for compatibility, use directory keyword
178
179   
180    <a name="#_find_keyword_NOPRO"></a>
181    <h4>NOPRO&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
182     
183     
184     
185     
186     
187     
188     
189     
190    </h4>
191
192     
193 activate to avoid the automatic search of filename completed with '.pro'
194
195   
196    <a name="#_find_keyword_ONLYPRO"></a>
197    <h4>ONLYPRO&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
198     
199     
200     
201     
202     
203     
204     
205     
206    </h4>
207
208     
209 force to look only at file ending with .pro
210
211   
212    <a name="#_find_keyword_ONLYNC"></a>
213    <h4>ONLYNC&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
214     
215     
216     
217     
218     
219     
220     
221     
222    </h4>
223
224     
225 force to look only at file ending with .nc
226
227   
228    <a name="#_find_keyword_UNIQUE"></a>
229    <h4>UNIQUE&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
230     
231     
232     
233     
234     
235     
236     
237     
238    </h4>
239
240     
241 activate to make sure that each element of the output vector is unique.
242
243   
244    <a name="#_find_keyword_FIRSTFOUND"></a>
245    <h4>FIRSTFOUND&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
246     
247     
248     
249     
250     
251     
252     
253     
254    </h4>
255
256     
257 activate this keyword to stop looking for the file as soon as we found one.
258
259   
260    <a name="#_find_keyword_LOOKALLDIR"></a>
261    <h4>LOOKALLDIR&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
262     
263     
264     
265     
266     
267     
268     
269     
270    </h4>
271
272     
273 activate to look for the file (with a recursive search if needed)
274 in . iodir, homedir, !path + the DATA:TestsData directory if it exists.
275
276   
277    <a name="#_find_keyword_TRYFIND"></a>
278    <h4>TRYFIND&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
279     
280     
281     
282     
283     
284     
285     
286     
287    </h4>
288
289     
290 if the file was not found and this keyword is activated, find will call
291 itself with the keywords /LOOKALLDIR and /FIRSTFOUND to try to find
292 the file we are looking for. Note that if the file was found at the
293 first try this keyword as no effect (which is not the case with LOOKALLDIR)
294
295   
296    <a name="#_find_keyword__EXTRA"></a>
297    <h4>_EXTRA&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
298     
299     
300     
301     
302     
303     
304     
305     
306    </h4>
307
308     
309 Used to pass keywords
310
311   
312   
313
314    <h3>Examples</h3><pre>
315
316 IDL> print, find('*loadct')
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', iodir=!dir,/recursive)
320   /usr/local/rsi/idl_6.0/lib/loadct.pro
321   /usr/local/rsi/idl_6.0/lib/utilities/xloadct.pro
322 IDL> print, find('*loadct.pro')
323   /usr/local/rsi/idl_6.0/lib/utilities/xloadct.pro
324   /usr/local/rsi/idl_6.0/lib/loadct.pro
325 IDL> print, find('*loadct',/nopro)
326   NOT FOUND
327 IDL> print, find('*loadct', iodir = '/usr/local/rsi/idl_6.0/lib')
328   /usr/local/rsi/idl_6.0/lib/loadct.pro
329 IDL> print, find('*loadct', iodir = '/usr/local/rsi/idl_6.0/lib', /test_write)
330   NOT FOUND
331 IDL> print, find('*loadct', iodir = '/usr/local/rsi/idl_6.0/lib', /recursive)
332   /usr/local/rsi/idl_6.0/lib/loadct.pro
333   /usr/local/rsi/idl_6.0/lib/utilities/xloadct.pro
334 IDL> print, find('mesh*', iodirectory = [iodir, !path])
335   /Users/sebastie/DATA/ORCA2/meshmaskORCA2closea.nc
336   /Users/sebastie/IDL/meshmaskclosesea.pro
337   /Users/sebastie/IDL/meshmaskclosesea.pro~
338   /Users/sebastie/SAXO_RD/Obsolete/meshlec.pro
339   /usr/local/rsi/idl_6.0/lib/mesh_obj.pro
340
341    </pre><h3>Version history</h3>
342   
343    <h4>Version</h4>
344 $Id: find.pro 232 2007-03-20 16:59:36Z pinsard $
345    <h4>History</h4>
346 Sebastien Masson (smasson@lodyc.jussieu.fr)
347                       28/4/1999
348                       6/7/1999: compatibility mac and windows
349 June 2005: Sebastien Masson: cleaning, use for file_* functions
350
351   
352
353   
354   
355   
356   
357   
358
359   
360   
361   
362   
363   
364   
365   
366
367    <font size="-3"><p>&nbsp;</p></font>
368    <hr size="1" color="#CCCCCC"/>
369     
370
371   
372
373    <p><font color="gray" size="-3">&nbsp;&nbsp;Produced by IDLdoc 2.0.</font></p>
374
375  </body>
376</html>
Note: See TracBrowser for help on using the repository browser.