- Timestamp:
- 06/07/06 19:12:14 (18 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/SRC/Documentation/idldoc_html_output/Utilities/find.html
r89 r93 87 87 </div> 88 88 89 <div id="file_comments"></div> 89 <div id="file_comments"> all file_search keywords can be used. 90 </div> 90 91 91 92 … … 102 103 <div class="routine_details" id="_find"> 103 104 104 <h2><a class="top" href="#container">top</a>find </h2> 105 <h2><a class="top" href="#container">top</a>find <span class="categories"> find a file 106 </span></h2> 105 107 106 108 <p class="header"> … … 108 110 109 111 <div class="comments"> 110 NAME:find 111 112 PURPOSE: based on file_search, but it is possible to speficy 112 based on file_search, but it is possible to speficy 113 113 a set of possibles names and a different set of 114 114 possibles directories names. 115 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 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 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 122 140 file names to match. Input names specifications may contain 123 141 wildcard characters, enabling them to match multiple files … … 125 143 necessary, find is looking for filename and also for filename 126 144 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 145 </div> 146 147 148 149 150 151 152 <h3>Keywords</h3> 153 154 <h4 id="_find_keyword_IODIRECTORY">IODIRECTORY 155 156 157 158 159 160 161 162 163 </h4> 164 165 <div class="comments"> A scalar or array variable of string type, containing 134 166 directories names where we are looking for the file. by defaut 135 167 we use !path. Different directories can be separated by … … 138 170 Note that if filename's dirname is different from '.', this 139 171 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. 172 </div> 173 174 <h4 id="_find_keyword_RECURSIVE">RECURSIVE 175 176 177 178 179 180 181 182 183 </h4> 184 185 <div class="comments"> performs recursive searching of directory hierarchies. 152 186 In a recursive search, find looks recursively for any and all 153 187 subdirectories in the file hierarchy rooted at the IODIRECTORY 154 188 argument. 155 156 REPERTOIRE: obsolete. keep for compatibility, use directory keyword 157 158 UNIQUE: activate to make sure that each element of the output 189 </div> 190 191 <h4 id="_find_keyword_REPERTOIRE">REPERTOIRE 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 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 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 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 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 159 260 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: 261 </div> 262 263 <h4 id="_find_keyword_FIRSTFOUND">FIRSTFOUND 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 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 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"> 175 309 176 310 IDL> print, find('*loadct') … … 199 333 /usr/local/rsi/idl_6.0/lib/mesh_obj.pro 200 334 </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 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> 365 342 366 343
Note: See TracChangeset
for help on using the changeset viewer.
