Context Navigation

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

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

Note: See TracBrowser for help on using the repository browser.

Download in other formats: