- Timestamp:
- 04/06/07 10:35:17 (17 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/SRC/Documentation/idldoc_assistant_output/Utilities/find.html
r234 r242 67 67 By default look for files included in !path 68 68 69 all file_searchkeywords can be used.69 all <proidl>file_search</proidl> keywords can be used. 70 70 71 71 … … 75 75 <a name="#_find"></a> 76 76 77 <h2>find <font size="-1" color="#006633"> 77 <h2>find <font size="-1" color="#006633"> 78 78 find a file 79 79 </font></h2> 80 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> 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>scalar string or array of strings</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 87 A scalar or array variable of string type, containing the 88 88 name (with the full path of the matching files. If no files 89 exist with names matching the input arguments, findreturns89 exist with names matching the input arguments, <a href=".//find.html">find</a> returns 90 90 the scalar string : 'NOT FOUND' 91 91 … … 102 102 <font size="-1" color="#006633">required</font> 103 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 104 <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string or array of strings</i></font> 105 106 107 </h4> 108 109 110 File name[s] to match. Input names specifications may contain 112 111 wildcard characters, enabling them to match multiple files 113 (see file_searchfor more informations). By default and if114 necessary, findis looking for filename and also for filename112 (see <proidl>file_search</proidl> for more informations). By default and if 113 necessary, <a href=".//find.html">find</a> is looking for filename and also for filename 115 114 completed with '.pro' 116 115 … … 129 128 130 129 131 130 <font size="-1" color="#006633">type:</font> <font size="-1" color="#006633"><i>scalar string or array of strings</i></font> 132 131 <font size="-1" color="#006633">default:</font> <font size="-1" color="#006633"><i>['.',!path]</i></font> 133 132 134 133 </h4> 135 134 136 137 A scalar or array variable of string type, containing 138 directories names where we are looking for the file. 135 136 Directories names where we are looking for the file. 139 137 Different directories can be separated by 140 138 path_sep(/search_path) (':' on unix type machine) as it is done … … 156 154 </h4> 157 155 158 156 159 157 performs recursive searching of directory hierarchies. 160 In a recursive search, findlooks recursively for any and all158 In a recursive search, <a href=".//find.html">find</a> looks recursively for any and all 161 159 subdirectories in the file hierarchy rooted at the IODIRECTORY argument. 162 160 … … 174 172 </h4> 175 173 176 177 obsolete. keep for compatibility, use directorykeyword174 175 obsolete. keep for compatibility, use IODIRECTORY keyword 178 176 179 177 … … 190 188 </h4> 191 189 192 190 193 191 activate to avoid the automatic search of filename completed with '.pro' 194 192 … … 206 204 </h4> 207 205 208 206 209 207 force to look only at file ending with .pro 210 208 … … 222 220 </h4> 223 221 224 222 225 223 force to look only at file ending with .nc 226 224 … … 238 236 </h4> 239 237 240 238 241 239 activate to make sure that each element of the output vector is unique. 242 240 … … 254 252 </h4> 255 253 256 254 257 255 activate this keyword to stop looking for the file as soon as we found one. 258 256 … … 270 268 </h4> 271 269 272 270 273 271 activate to look for the file (with a recursive search if needed) 274 272 in . iodir, homedir, !path + the DATA:TestsData directory if it exists. … … 287 285 </h4> 288 286 289 290 if the file was not found and this keyword is activated, find will call 287 288 if the file was not found and this keyword is activated, <a href=".//find.html">find</a> 289 will call 291 290 itself with the keywords /LOOKALLDIR and /FIRSTFOUND to try to find 292 291 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) 292 first try this keyword as no effect (which is not the case with LOOKALLDIR) 294 293 295 294 … … 306 305 </h4> 307 306 308 307 309 308 Used to pass keywords 310 309 … … 313 312 314 313 <h3>Examples</h3><pre> 315 316 314 IDL> print, find('*loadct') 317 315 /usr/local/rsi/idl_6.0/lib/utilities/xloadct.pro … … 342 340 343 341 <h4>Version</h4> 344 $Id: find.pro 232 2007-03-20 16:59:36Z pinsard $ 342 $Id: find.pro 239 2007-03-28 06:50:03Z smasson $ 343 345 344 <h4>History</h4> 346 345 Sebastien Masson (smasson@lodyc.jussieu.fr)
Note: See TracChangeset
for help on using the changeset viewer.