- Timestamp:
- 06/07/06 19:12:14 (18 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/SRC/Documentation/idldoc_html_output/Utilities/isafile.html
r89 r93 87 87 </div> 88 88 89 <div id="file_comments"></div> 89 <div id="file_comments"> all find, file_search and dialog_pickfile keywords (like title) 90 can be used 91 </div> 90 92 91 93 … … 102 104 <div class="routine_details" id="_isafile"> 103 105 104 <h2><a class="top" href="#container">top</a>isafile </h2> 106 <h2><a class="top" href="#container">top</a>isafile <span class="categories"> io 107 108 </span></h2> 105 109 106 110 <p class="header"> 107 <span class="result">result = </span>isafile(<span class="result"> <a href="#_isafile_param_filein">filein</a></span>, <a href="#_isafile_keyword_FILENAME">FILENAME</a>=<span class="result">FILENAME</span>, <a href="#_isafile_keyword_IODIRECTORY">IODIRECTORY</a>=<span class="result">IODIRECTORY</span>, <a href="#_isafile_keyword_NEW">NEW</a>=<span class="result">NEW</span>, <a href="#_isafile_keyword_RECURSIVE">RECURSIVE</a>=<span class="result">RECURSIVE</span>, <a href="#_isafile_keyword_ONLYPRO">ONLYPRO</a>=<span class="result">ONLYPRO</span>, <a href="#_isafile_keyword_ONLYNC">ONLYNC</a>=<span class="result">ONLYNC</span>, <a href="#_isafile_keyword__extra">_extra</a>=<span class="result">_extra</span>)</p>111 <span class="result">result = </span>isafile(<span class="result">[<a href="#_isafile_param_filein">filein</a>]</span>, <a href="#_isafile_keyword_FILENAME">FILENAME</a>=<span class="result">FILENAME</span>, <a href="#_isafile_keyword_IODIRECTORY">IODIRECTORY</a>=<span class="result">IODIRECTORY</span>, <a href="#_isafile_keyword_NEW">NEW</a>=<span class="result">NEW</span>, <a href="#_isafile_keyword_RECURSIVE">RECURSIVE</a>=<span class="result">RECURSIVE</span>, <a href="#_isafile_keyword_ONLYPRO">ONLYPRO</a>=<span class="result">ONLYPRO</span>, <a href="#_isafile_keyword_ONLYNC">ONLYNC</a>=<span class="result">ONLYNC</span>, <a href="#_isafile_keyword__extra">_extra</a>=<span class="result">_extra</span>)</p> 108 112 109 113 <div class="comments"> 110 NAME: isafile 111 112 PURPOSE: same as find.pro except that as long as the file is 'NOT FOUND', 114 same as find.pro except that as long as the file is 'NOT FOUND', 113 115 isafile calls dialog_pickfile, to ask the user to select a file. 114 115 CATEGORY: io 116 117 CALLING SEQUENCE:filename = isafile([filein]) 118 119 INPUTS:optional:a proposed name. If neither filein 116 </div> 117 118 <h3>Return value</h3><div class="value"> the filename with its path 119 </div> 120 121 122 <h3>Parameters</h3> 123 124 125 <h4 id="_isafile_param_filein">filein 126 <span class="attr">in</span> 127 128 <span class="attr">optional</span> 129 130 131 132 133 134 </h4> 135 136 <div class="comments"> a proposed name. If neither filein 120 137 input parameter of filename keyword are defined, 121 138 the ask the user to choose a file. 122 123 KEYWORD PARAMETERS: 124 125 FILENAME: a proposed filename. 126 127 IODIRECTORY: a directory where we look for the file. this 139 </div> 140 141 142 143 144 145 146 <h3>Keywords</h3> 147 148 <h4 id="_isafile_keyword_FILENAME">FILENAME 149 150 151 152 153 154 155 156 157 </h4> 158 159 <div class="comments"> a proposed filename. 160 </div> 161 162 <h4 id="_isafile_keyword_IODIRECTORY">IODIRECTORY 163 164 165 166 167 168 169 170 171 </h4> 172 173 <div class="comments"> a directory where we look for the file. this 128 174 keyword is taken into account only if the dirmame 129 175 of filein or filename is '.' 130 131 /NEW:to specify that filename is a new file and that 176 </div> 177 178 <h4 id="_isafile_keyword_NEW">NEW 179 180 181 182 183 184 185 186 187 </h4> 188 189 <div class="comments"> to specify that filename is a new file and that 132 190 we should check only its path 133 134 ONLYPRO:force to look only at file ending with .pro 135 136 ONLYNC:force to look only at file ending with .nc 137 138 RECURSIVE: performs recursive searching of directory hierarchies. 191 </div> 192 193 <h4 id="_isafile_keyword_RECURSIVE">RECURSIVE 194 195 196 197 198 199 200 201 202 </h4> 203 204 <div class="comments"> performs recursive searching of directory hierarchies. 139 205 In a recursive search, find looks recursively for any and all 140 206 subdirectories in the file hierarchy rooted at the IODIRECTORY 141 207 argument. 142 143 all find, file_search and dialog_pickfile keywords (like title) 144 145 OUTPUTS:the filename with its path 146 147 COMMON BLOCKS:none 148 149 SIDE EFFECTS: 150 151 RESTRICTIONS: 152 153 EXAMPLE: 208 </div> 209 210 <h4 id="_isafile_keyword_ONLYPRO">ONLYPRO 211 212 213 214 215 216 217 218 219 </h4> 220 221 <div class="comments"> force to look only at file ending with .pro 222 </div> 223 224 <h4 id="_isafile_keyword_ONLYNC">ONLYNC 225 226 227 228 229 230 231 232 233 </h4> 234 235 <div class="comments"> force to look only at file ending with .nc 236 </div> 237 238 <h4 id="_isafile_keyword__extra">_extra 239 240 241 242 243 244 245 246 247 </h4> 248 249 <div class="comments"></div> 250 251 252 253 <h3>Examples</h3><div class="value"> 154 254 155 255 IDL> print, isafile('/Users/sebastie/SAXO_RD/Commons/cm_4mesh.pro') … … 165 265 IDL> print, isafile('fake_file.pro') 166 266 </div> 167 168 169 170 171 <h3>Parameters</h3> 172 173 174 <h4 id="_isafile_param_filein">filein 175 176 177 178 179 180 181 182 183 </h4> 184 185 <div class="comments"></div> 186 187 188 189 190 191 192 <h3>Keywords</h3> 193 194 <h4 id="_isafile_keyword_FILENAME">FILENAME 195 196 197 198 199 200 201 202 203 </h4> 204 205 <div class="comments"></div> 206 207 <h4 id="_isafile_keyword_IODIRECTORY">IODIRECTORY 208 209 210 211 212 213 214 215 216 </h4> 217 218 <div class="comments"></div> 219 220 <h4 id="_isafile_keyword_NEW">NEW 221 222 223 224 225 226 227 228 229 </h4> 230 231 <div class="comments"></div> 232 233 <h4 id="_isafile_keyword_RECURSIVE">RECURSIVE 234 235 236 237 238 239 240 241 242 </h4> 243 244 <div class="comments"></div> 245 246 <h4 id="_isafile_keyword_ONLYPRO">ONLYPRO 247 248 249 250 251 252 253 254 255 </h4> 256 257 <div class="comments"></div> 258 259 <h4 id="_isafile_keyword_ONLYNC">ONLYNC 260 261 262 263 264 265 266 267 268 </h4> 269 270 <div class="comments"></div> 271 272 <h4 id="_isafile_keyword__extra">_extra 273 274 275 276 277 278 279 280 281 </h4> 282 283 <div class="comments"></div> 284 285 286 287 288 289 290 291 267 <h3>Version history</h3> 268 269 270 <h4>History</h4><div class="value"> Sebastien Masson (smasson@lodyc.jussieu.fr) 271 11/2/2000 272 June 2005: Sebastien Masson: cleaning, use for file_* functions</div> 292 273 293 274
Note: See TracChangeset
for help on using the changeset viewer.
