[89] | 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 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="isadirectory.html">next file >></a> <a href="find.html" target="_TOP">view single page</a> | <a href="./../index.html?format=raw" 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?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"></div> |
---|
| 90 | |
---|
| 91 | |
---|
| 92 | |
---|
| 93 | |
---|
| 94 | |
---|
| 95 | |
---|
| 96 | |
---|
| 97 | |
---|
| 98 | |
---|
| 99 | <div id="routine_details"> |
---|
| 100 | |
---|
| 101 | |
---|
| 102 | <div class="routine_details" id="_find"> |
---|
| 103 | |
---|
| 104 | <h2><a class="top" href="#container">top</a>find </h2> |
---|
| 105 | |
---|
| 106 | <p class="header"> |
---|
| 107 | <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> |
---|
| 108 | |
---|
| 109 | <div class="comments"> |
---|
| 110 | NAME:find |
---|
| 111 | |
---|
| 112 | PURPOSE: 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 | |
---|
| 117 | CATEGORY:find a file |
---|
| 118 | |
---|
| 119 | CALLING SEQUENCE: found = find(filename) |
---|
| 120 | |
---|
| 121 | INPUTS: A scalar or array variable of string type, containing |
---|
| 122 | file names to match. Input names specifications may contain |
---|
| 123 | wildcard characters, enabling them to match multiple files |
---|
| 124 | (see file_search for more informations). By defaut and if |
---|
| 125 | necessary, find is looking for filename and also for filename |
---|
| 126 | completed with '.pro' |
---|
| 127 | |
---|
| 128 | KEYWORD PARAMETERS: |
---|
| 129 | |
---|
| 130 | FIRSTFOUND: activate this keyword to stop looking for the file as |
---|
| 131 | soon as we found one. |
---|
| 132 | |
---|
| 133 | IODIRECTORY: A scalar or array variable of string type, containing |
---|
| 134 | directories names where we are looking for the file. by defaut |
---|
| 135 | we use !path. Different directories can be separated by |
---|
| 136 | path_sep(/search_path) (':' on unix type machine) as it is done |
---|
| 137 | to define !path. |
---|
| 138 | Note that if filename's dirname is different from '.', this |
---|
| 139 | keyword is not taken into account. |
---|
| 140 | |
---|
| 141 | LOOKALLDIR:activate to look for the file with a recursive search |
---|
| 142 | in iodir, homedir, !path + the DATA:TestsData directory if it exists. |
---|
| 143 | |
---|
| 144 | NOPRO: activate to avoid the automatic search of filename |
---|
| 145 | completed with '.pro' |
---|
| 146 | |
---|
| 147 | ONLYPRO:force to look only at file ending with .pro |
---|
| 148 | |
---|
| 149 | ONLYNC:force to look only at file ending with .nc |
---|
| 150 | |
---|
| 151 | RECURSIVE: performs recursive searching of directory hierarchies. |
---|
| 152 | In a recursive search, find looks recursively for any and all |
---|
| 153 | subdirectories in the file hierarchy rooted at the IODIRECTORY |
---|
| 154 | argument. |
---|
| 155 | |
---|
| 156 | REPERTOIRE: obsolete. keep for compatibility, use directory keyword |
---|
| 157 | |
---|
| 158 | UNIQUE: activate to make sure that each element of the output |
---|
| 159 | vector is unique. |
---|
| 160 | |
---|
| 161 | all file_search keywords |
---|
| 162 | |
---|
| 163 | OUTPUTS: A scalar or array variable of string type, containing the |
---|
| 164 | name (with the full path of the matching files. If no files |
---|
| 165 | exist with names matching the input arguments, find returns |
---|
| 166 | the scalar string : 'NOT FOUND' |
---|
| 167 | |
---|
| 168 | COMMON BLOCKS: none |
---|
| 169 | |
---|
| 170 | SIDE EFFECTS: |
---|
| 171 | |
---|
| 172 | RESTRICTIONS: |
---|
| 173 | |
---|
| 174 | EXAMPLE: |
---|
| 175 | |
---|
| 176 | IDL> print, find('*loadct') |
---|
| 177 | /usr/local/rsi/idl_6.0/lib/utilities/xloadct.pro |
---|
| 178 | /usr/local/rsi/idl_6.0/lib/loadct.pro |
---|
| 179 | IDL> print, find('*loadct', iodir=!dir,/recursive) |
---|
| 180 | /usr/local/rsi/idl_6.0/lib/loadct.pro |
---|
| 181 | /usr/local/rsi/idl_6.0/lib/utilities/xloadct.pro |
---|
| 182 | IDL> print, find('*loadct.pro') |
---|
| 183 | /usr/local/rsi/idl_6.0/lib/utilities/xloadct.pro |
---|
| 184 | /usr/local/rsi/idl_6.0/lib/loadct.pro |
---|
| 185 | IDL> print, find('*loadct',/nopro) |
---|
| 186 | NOT FOUND |
---|
| 187 | IDL> print, find('*loadct', iodir = '/usr/local/rsi/idl_6.0/lib') |
---|
| 188 | /usr/local/rsi/idl_6.0/lib/loadct.pro |
---|
| 189 | IDL> print, find('*loadct', iodir = '/usr/local/rsi/idl_6.0/lib', /test_write) |
---|
| 190 | NOT FOUND |
---|
| 191 | IDL> print, find('*loadct', iodir = '/usr/local/rsi/idl_6.0/lib', /recursive) |
---|
| 192 | /usr/local/rsi/idl_6.0/lib/loadct.pro |
---|
| 193 | /usr/local/rsi/idl_6.0/lib/utilities/xloadct.pro |
---|
| 194 | IDL> print, find('mesh*', iodirectory = [iodir, !path]) |
---|
| 195 | /Users/sebastie/DATA/ORCA2/meshmaskORCA2closea.nc |
---|
| 196 | /Users/sebastie/IDL/meshmaskclosesea.pro |
---|
| 197 | /Users/sebastie/IDL/meshmaskclosesea.pro~ |
---|
| 198 | /Users/sebastie/SAXO_RD/Obsolete/meshlec.pro |
---|
| 199 | /usr/local/rsi/idl_6.0/lib/mesh_obj.pro |
---|
| 200 | </div> |
---|
| 201 | |
---|
| 202 | |
---|
| 203 | |
---|
| 204 | |
---|
| 205 | <h3>Parameters</h3> |
---|
| 206 | |
---|
| 207 | |
---|
| 208 | <h4 id="_find_param_filein">filein |
---|
| 209 | |
---|
| 210 | |
---|
| 211 | |
---|
| 212 | |
---|
| 213 | |
---|
| 214 | |
---|
| 215 | |
---|
| 216 | |
---|
| 217 | </h4> |
---|
| 218 | |
---|
| 219 | <div class="comments"></div> |
---|
| 220 | |
---|
| 221 | |
---|
| 222 | |
---|
| 223 | |
---|
| 224 | |
---|
| 225 | |
---|
| 226 | <h3>Keywords</h3> |
---|
| 227 | |
---|
| 228 | <h4 id="_find_keyword_IODIRECTORY">IODIRECTORY |
---|
| 229 | |
---|
| 230 | |
---|
| 231 | |
---|
| 232 | |
---|
| 233 | |
---|
| 234 | |
---|
| 235 | |
---|
| 236 | |
---|
| 237 | </h4> |
---|
| 238 | |
---|
| 239 | <div class="comments"></div> |
---|
| 240 | |
---|
| 241 | <h4 id="_find_keyword_RECURSIVE">RECURSIVE |
---|
| 242 | |
---|
| 243 | |
---|
| 244 | |
---|
| 245 | |
---|
| 246 | |
---|
| 247 | |
---|
| 248 | |
---|
| 249 | |
---|
| 250 | </h4> |
---|
| 251 | |
---|
| 252 | <div class="comments"></div> |
---|
| 253 | |
---|
| 254 | <h4 id="_find_keyword_REPERTOIRE">REPERTOIRE |
---|
| 255 | |
---|
| 256 | |
---|
| 257 | |
---|
| 258 | |
---|
| 259 | |
---|
| 260 | |
---|
| 261 | |
---|
| 262 | |
---|
| 263 | </h4> |
---|
| 264 | |
---|
| 265 | <div class="comments"></div> |
---|
| 266 | |
---|
| 267 | <h4 id="_find_keyword_NOPRO">NOPRO |
---|
| 268 | |
---|
| 269 | |
---|
| 270 | |
---|
| 271 | |
---|
| 272 | |
---|
| 273 | |
---|
| 274 | |
---|
| 275 | |
---|
| 276 | </h4> |
---|
| 277 | |
---|
| 278 | <div class="comments"></div> |
---|
| 279 | |
---|
| 280 | <h4 id="_find_keyword_ONLYPRO">ONLYPRO |
---|
| 281 | |
---|
| 282 | |
---|
| 283 | |
---|
| 284 | |
---|
| 285 | |
---|
| 286 | |
---|
| 287 | |
---|
| 288 | |
---|
| 289 | </h4> |
---|
| 290 | |
---|
| 291 | <div class="comments"></div> |
---|
| 292 | |
---|
| 293 | <h4 id="_find_keyword_ONLYNC">ONLYNC |
---|
| 294 | |
---|
| 295 | |
---|
| 296 | |
---|
| 297 | |
---|
| 298 | |
---|
| 299 | |
---|
| 300 | |
---|
| 301 | |
---|
| 302 | </h4> |
---|
| 303 | |
---|
| 304 | <div class="comments"></div> |
---|
| 305 | |
---|
| 306 | <h4 id="_find_keyword_UNIQUE">UNIQUE |
---|
| 307 | |
---|
| 308 | |
---|
| 309 | |
---|
| 310 | |
---|
| 311 | |
---|
| 312 | |
---|
| 313 | |
---|
| 314 | |
---|
| 315 | </h4> |
---|
| 316 | |
---|
| 317 | <div class="comments"></div> |
---|
| 318 | |
---|
| 319 | <h4 id="_find_keyword_FIRSTFOUND">FIRSTFOUND |
---|
| 320 | |
---|
| 321 | |
---|
| 322 | |
---|
| 323 | |
---|
| 324 | |
---|
| 325 | |
---|
| 326 | |
---|
| 327 | |
---|
| 328 | </h4> |
---|
| 329 | |
---|
| 330 | <div class="comments"></div> |
---|
| 331 | |
---|
| 332 | <h4 id="_find_keyword_LOOKALLDIR">LOOKALLDIR |
---|
| 333 | |
---|
| 334 | |
---|
| 335 | |
---|
| 336 | |
---|
| 337 | |
---|
| 338 | |
---|
| 339 | |
---|
| 340 | |
---|
| 341 | </h4> |
---|
| 342 | |
---|
| 343 | <div class="comments"></div> |
---|
| 344 | |
---|
| 345 | <h4 id="_find_keyword__extra">_extra |
---|
| 346 | |
---|
| 347 | |
---|
| 348 | |
---|
| 349 | |
---|
| 350 | |
---|
| 351 | |
---|
| 352 | |
---|
| 353 | |
---|
| 354 | </h4> |
---|
| 355 | |
---|
| 356 | <div class="comments"></div> |
---|
| 357 | |
---|
| 358 | |
---|
| 359 | |
---|
| 360 | |
---|
| 361 | |
---|
| 362 | |
---|
| 363 | |
---|
| 364 | |
---|
| 365 | |
---|
| 366 | |
---|
| 367 | |
---|
| 368 | |
---|
| 369 | |
---|
| 370 | |
---|
| 371 | |
---|
| 372 | |
---|
| 373 | |
---|
| 374 | |
---|
| 375 | |
---|
| 376 | |
---|
| 377 | |
---|
| 378 | |
---|
| 379 | |
---|
| 380 | |
---|
| 381 | |
---|
| 382 | |
---|
| 383 | </div> |
---|
| 384 | |
---|
| 385 | </div> |
---|
| 386 | |
---|
| 387 | |
---|
| 388 | |
---|
| 389 | <div id="tagline">Produced by IDLdoc 2.0.</div> |
---|
| 390 | |
---|
| 391 | </div> |
---|
| 392 | |
---|
| 393 | </body> |
---|
| 394 | </html> |
---|