Changeset 93 for trunk/SRC/Documentation/idldoc_html_output/Utilities
- Timestamp:
- 06/07/06 19:12:14 (18 years ago)
- Location:
- trunk/SRC/Documentation/idldoc_html_output/Utilities
- Files:
-
- 9 edited
-
createfunc.html (modified) (1 diff)
-
createpro.html (modified) (2 diffs)
-
def_myuniquetmpdir.html (modified) (5 diffs)
-
demomode_compatibility.html (modified) (1 diff)
-
directory-overview.html (modified) (2 diffs)
-
find.html (modified) (6 diffs)
-
isadirectory.html (modified) (3 diffs)
-
isafile.html (modified) (3 diffs)
-
protype.html (modified) (3 diffs)
Legend:
- Unmodified
- Added
- Removed
-
trunk/SRC/Documentation/idldoc_html_output/Utilities/createfunc.html
r89 r93 108 108 109 109 <div class="comments"> 110 NAME:createfunc 111 112 PURPOSE: write an idl function, compile it and execute it. 113 usefull to avoid the use of execute 114 115 CATEGORY: 116 117 CALLING SEQUENCE:res = createfunc(command) 118 119 INPUTS: 120 command: a scalar string defining the result to be byven back by the 121 function. (see examples) 122 123 KEYWORD PARAMETERS: 124 125 FILENAMEIN: name of the funccedure to be created. 126 'for_createfunc.pro' by default 127 128 KWDLIST: a vector string. to specify a list of keywords that 110 write an idl function, compile it and execute it. 111 usefull to avoid the use of execute 112 </div> 113 114 115 116 117 <h3>Parameters</h3> 118 119 120 <h4 id="_createfunc_param_command">command 121 <span class="attr">in</span> 122 123 124 <span class="attr">required</span> 125 126 127 128 129 </h4> 130 131 <div class="comments"> a scalar string defining the result to be byven back by the function. (see examples) 132 </div> 133 134 135 136 137 138 139 <h3>Keywords</h3> 140 141 <h4 id="_createfunc_keyword_FILENAMEIN">FILENAMEIN 142 <span class="attr">in</span> 143 144 145 146 147 148 149 150 </h4> 151 152 <div class="comments"> name of the funccedure to be created. 153 'for_createfunc.pro' by default</div> 154 155 <h4 id="_createfunc_keyword_KWDLIST">KWDLIST 156 <span class="attr">in</span> 157 158 159 160 161 162 163 164 </h4> 165 166 <div class="comments"> a vector string. to specify a list of keywords that 129 167 must be included in the function definition. Warning: the string 130 168 must start with a ',' for example: KWDLIST = ', TOTO = toto' 131 132 _EXTRA: used to pass your keywords to the created function. 133 134 OUTPUTS: none 135 136 COMMON BLOCKS: none 169 </div> 170 171 <h4 id="_createfunc_keyword__extra">_extra 172 173 174 175 176 177 178 179 180 </h4> 181 182 <div class="comments"> used to pass your keywords to the created function. 137 183 138 184 SIDE EFFECTS: ends the function name with '.pro' if needed 139 140 RESTRICTIONS:arguments can be given only through keywords 141 142 EXAMPLE: 185 </div> 186 187 188 189 <h3>Examples</h3><div class="value"> 143 190 IDL> print, createfunc('3*2', filename='test') 144 191 IDL> print, createfunc('3*two', filename = 'test' $ 145 192 , kwdlist ='two = two', two = 2) 146 193 </div> 147 148 149 150 151 <h3>Parameters</h3> 152 153 154 <h4 id="_createfunc_param_command">command 155 156 157 158 159 160 161 162 163 </h4> 164 165 <div class="comments"></div> 166 167 168 169 170 171 172 <h3>Keywords</h3> 173 174 <h4 id="_createfunc_keyword_FILENAMEIN">FILENAMEIN 175 176 177 178 179 180 181 182 183 </h4> 184 185 <div class="comments"></div> 186 187 <h4 id="_createfunc_keyword_KWDLIST">KWDLIST 188 189 190 191 192 193 194 195 196 </h4> 197 198 <div class="comments"></div> 199 200 <h4 id="_createfunc_keyword__extra">_extra 201 202 203 204 205 206 207 208 209 </h4> 210 211 <div class="comments"></div> 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 194 <h3>Version history</h3> 195 196 197 <h4>History</h4><div class="value"> Sebastien Masson (smasson@lodyc.jussieu.fr) 198 May 2005</div> 199 200 201 <h3>Known issues</h3> 202 203 204 205 <h4>Restrictions</h4><div class="value"> arguments can be given only through keywords 206 </div> 227 207 228 208 -
trunk/SRC/Documentation/idldoc_html_output/Utilities/createpro.html
r89 r93 108 108 109 109 <div class="comments"> 110 NAME:createpro 111 112 PURPOSE: write an idl procedure, compile it and execute it. 113 114 CATEGORY: 115 116 CALLING SEQUENCE:createpro, command 117 118 INPUTS: 119 command: a string array defining the procedure to be created. 120 each element will be a line of the created procedure. 121 122 KEYWORD PARAMETERS: 123 124 FILENAMEIN: name of the procedure to be created. 110 write an idl procedure, compile it and execute it. 111 </div> 112 113 114 115 116 <h3>Parameters</h3> 117 118 119 <h4 id="_createpro_param_command">command 120 <span class="attr">in</span> 121 122 123 <span class="attr">required</span> 124 125 126 127 128 </h4> 129 130 <div class="comments"> a string array defining the procedure to be created. each element will be a line of the created procedure. 131 </div> 132 133 134 135 136 137 138 <h3>Keywords</h3> 139 140 <h4 id="_createpro_keyword_FILENAMEIN">FILENAMEIN 141 142 143 144 145 146 147 148 149 </h4> 150 151 <div class="comments"> name of the procedure to be created. 125 152 'for_createpro.pro' by default 126 127 KWDLIST: a vector string. to specify a list of keywords that 153 </div> 154 155 <h4 id="_createpro_keyword_KWDLIST">KWDLIST 156 157 158 159 160 161 162 163 164 </h4> 165 166 <div class="comments"> a vector string. to specify a list of keywords that 128 167 must be included in the procedure definition. Warning: the string 129 168 must start with a ',' for example: KWDLIST = ', TOTO = toto' 130 131 _EXTRA: used to pass your keywords to the created procedure. 132 133 OUTPUTS: none 134 135 COMMON BLOCKS: none 169 </div> 170 171 <h4 id="_createpro_keyword_KWDUSED">KWDUSED 172 173 174 175 176 177 178 179 180 </h4> 181 182 <div class="comments"></div> 183 184 <h4 id="_createpro_keyword__extra">_extra 185 186 187 188 189 190 191 192 193 </h4> 194 195 <div class="comments"> used to pass your keywords to the created procedure. 136 196 137 197 SIDE EFFECTS: ends the procedure name with '.pro' if needed 138 139 RESTRICTIONS:is not working with functions, use createfunc instead. 140 arguments can be given only through keywords 141 142 EXAMPLE: 198 </div> 199 200 201 202 <h3>Examples</h3><div class="value"> 143 203 IDL> createpro, ['print,''OK'''], filename='test' 144 204 IDL> createpro, ['if keyword_set(ok) then print,''OK'' else print, ''No'''] $ … … 148 208 149 209 </div> 150 151 152 153 154 <h3>Parameters</h3> 155 156 157 <h4 id="_createpro_param_command">command 158 159 160 161 162 163 164 165 166 </h4> 167 168 <div class="comments"></div> 169 170 171 172 173 174 175 <h3>Keywords</h3> 176 177 <h4 id="_createpro_keyword_FILENAMEIN">FILENAMEIN 178 179 180 181 182 183 184 185 186 </h4> 187 188 <div class="comments"></div> 189 190 <h4 id="_createpro_keyword_KWDLIST">KWDLIST 191 192 193 194 195 196 197 198 199 </h4> 200 201 <div class="comments"></div> 202 203 <h4 id="_createpro_keyword_KWDUSED">KWDUSED 204 205 206 207 208 209 210 211 212 </h4> 213 214 <div class="comments"></div> 215 216 <h4 id="_createpro_keyword__extra">_extra 217 218 219 220 221 222 223 224 225 </h4> 226 227 <div class="comments"></div> 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 210 <h3>Version history</h3> 211 212 213 <h4>History</h4><div class="value"> Sebastien Masson (smasson@lodyc.jussieu.fr) 214 cleaning + new keywords: October 2005 215 Feb. 2006: supress keyword "kwdused" and use call_procedure instead of execute</div> 216 217 218 <h3>Known issues</h3> 219 220 221 222 <h4>Restrictions</h4><div class="value"> is not working with functions, use createfunc instead. 223 arguments can be given only through keywords 224 </div> 243 225 244 226 -
trunk/SRC/Documentation/idldoc_html_output/Utilities/def_myuniquetmpdir.html
r89 r93 87 87 </div> 88 88 89 <div id="file_comments"></div> 89 <div id="file_comments"> SIDE EFFECTS: see purpose 90 </div> 90 91 91 92 … … 102 103 <div class="routine_details" id="_def_myuniquetmpdir"> 103 104 104 <h2><a class="top" href="#container">top</a>def_myuniquetmpdir </h2> 105 <h2><a class="top" href="#container">top</a>def_myuniquetmpdir <span class="categories"> utilities 106 </span></h2> 105 107 106 108 <p class="header"> … … 108 110 109 111 <div class="comments"> 110 NAME: def_myuniquetmpdir 111 112 PURPOSE: if needed, define and create myuniquetmpdir 113 (common variable from cm_general) and add it to !path 114 115 CATEGORY: utilities 116 117 CALLING SEQUENCE:def_myuniquetmpdir 118 119 COMMON BLOCKS: cm_general 120 121 SIDE EFFECTS: see purpose 112 if needed, define and create myuniquetmpdir 113 (common variable from cm_general) and add it to !path 122 114 </div> 123 115 … … 128 120 129 121 122 <h3>Examples</h3><div class="value"> 123 IDL> def_myuniquetmpdir 124 </div> 125 <h3>Version history</h3> 130 126 131 127 132 133 134 128 <h4>History</h4><div class="value"> Sebastien Masson (smasson@lodyc.jussieu.fr) 129 June 2005 130 </div> 135 131 136 132 … … 141 137 142 138 139 <h3>Other attributes</h3> 143 140 144 141 145 146 142 <h4>Uses routines</h4><div class="value"> cm_general 143 </div> 147 144 148 145 -
trunk/SRC/Documentation/idldoc_html_output/Utilities/demomode_compatibility.html
r89 r93 102 102 <div class="routine_details" id="_demomode_compatibility"> 103 103 104 <h2><a class="top" href="#container">top</a>demomode_compatibility < /h2>104 <h2><a class="top" href="#container">top</a>demomode_compatibility <span class="categories"> utilities</span></h2> 105 105 106 106 <p class="header"> -
trunk/SRC/Documentation/idldoc_html_output/Utilities/directory-overview.html
r89 r93 96 96 97 97 <dt><a href="def_myuniquetmpdir.html?format=raw">def_myuniquetmpdir.pro</a></dt> 98 <dd> </dd>98 <dd> SIDE EFFECTS: see purpose </dd> 99 99 100 100 <dt><a href="demomode_compatibility.html?format=raw">demomode_compatibility.pro</a></dt> … … 102 102 103 103 <dt><a href="find.html?format=raw">find.pro</a></dt> 104 <dd> </dd>104 <dd> all file_search keywords can be used.</dd> 105 105 106 106 <dt><a href="isadirectory.html?format=raw">isadirectory.pro</a></dt> 107 <dd> </dd>107 <dd> all dialog_pickfile keywords (like filter) can be used.</dd> 108 108 109 109 <dt><a href="isafile.html?format=raw">isafile.pro</a></dt> 110 <dd> </dd>110 <dd> all find, file_search and dialog_pickfile keywords (like title) can be used </dd> 111 111 112 112 <dt><a href="protype.html?format=raw">protype.pro</a></dt> -
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 -
trunk/SRC/Documentation/idldoc_html_output/Utilities/isadirectory.html
r89 r93 87 87 </div> 88 88 89 <div id="file_comments"></div> 89 <div id="file_comments"> all dialog_pickfile keywords (like filter) can be used. 90 </div> 90 91 91 92 … … 102 103 <div class="routine_details" id="_isadirectory"> 103 104 104 <h2><a class="top" href="#container">top</a>isadirectory </h2> 105 <h2><a class="top" href="#container">top</a>isadirectory <span class="categories"> io 106 </span></h2> 105 107 106 108 <p class="header"> 107 <span class="result">result = </span>isadirectory(<span class="result"> <a href="#_isadirectory_param_directoryin">directoryin</a></span>, <a href="#_isadirectory_keyword_TITLE">TITLE</a>=<span class="result">TITLE</span>, <a href="#_isadirectory_keyword_IODIRECTORY">IODIRECTORY</a>=<span class="result">IODIRECTORY</span>, <a href="#_isadirectory_keyword__extra">_extra</a>=<span class="result">_extra</span>)</p>109 <span class="result">result = </span>isadirectory(<span class="result">[<a href="#_isadirectory_param_directoryin">directoryin</a>]</span>, <a href="#_isadirectory_keyword_TITLE">TITLE</a>=<span class="result">TITLE</span>, <a href="#_isadirectory_keyword_IODIRECTORY">IODIRECTORY</a>=<span class="result">IODIRECTORY</span>, <a href="#_isadirectory_keyword__extra">_extra</a>=<span class="result">_extra</span>)</p> 108 110 109 111 <div class="comments"> 110 NAME:isadirectory 111 112 PURPOSE:check if a directory exists and make sure that it ends 112 check if a directory exists and make sure that it ends 113 113 with the directory separator mark. 114 115 CATEGORY: io 116 117 CALLING SEQUENCE: directory=isadirectory([dirname]) 118 119 INPUTS:optional:a proposed directory. If neither dirname 114 </div> 115 116 <h3>Return value</h3><div class="value"> the directory name 117 </div> 118 119 120 <h3>Parameters</h3> 121 122 123 <h4 id="_isadirectory_param_directoryin">directoryin 124 <span class="attr">in</span> 125 126 <span class="attr">optional</span> 127 128 129 130 131 132 </h4> 133 134 <div class="comments"> a proposed directory. If neither dirname 120 135 input parameter of IODIRECTORY keyword are defined, 121 136 the ask the user to choose a directory. 122 123 KEYWORD PARAMETERS: 124 125 IODIRECTORY:a proposed directory 126 127 TITLE = the title of the window 128 129 all dialog_pickfile keywords (like filter) 130 131 OUTPUTS: the directory name 132 133 COMMON BLOCKS:none 134 135 SIDE EFFECTS: 136 137 RESTRICTIONS: 138 139 EXAMPLE: 137 </div> 138 139 140 141 142 143 144 <h3>Keywords</h3> 145 146 <h4 id="_isadirectory_keyword_TITLE">TITLE 147 148 149 150 151 152 153 154 155 </h4> 156 157 <div class="comments"> the title of the window 158 </div> 159 160 <h4 id="_isadirectory_keyword_IODIRECTORY">IODIRECTORY 161 162 163 164 165 166 167 168 169 </h4> 170 171 <div class="comments"> a proposed directory 172 </div> 173 174 <h4 id="_isadirectory_keyword__extra">_extra 175 176 177 178 179 180 181 182 183 </h4> 184 185 <div class="comments"></div> 186 187 188 189 <h3>Examples</h3><div class="value"> 140 190 141 191 IDL> print, !dir … … 145 195 IDL> print, isadirectory(!dir+'notgood') 146 196 </div> 147 148 149 150 151 <h3>Parameters</h3> 152 153 154 <h4 id="_isadirectory_param_directoryin">directoryin 155 156 157 158 159 160 161 162 163 </h4> 164 165 <div class="comments"></div> 166 167 168 169 170 171 172 <h3>Keywords</h3> 173 174 <h4 id="_isadirectory_keyword_TITLE">TITLE 175 176 177 178 179 180 181 182 183 </h4> 184 185 <div class="comments"></div> 186 187 <h4 id="_isadirectory_keyword_IODIRECTORY">IODIRECTORY 188 189 190 191 192 193 194 195 196 </h4> 197 198 <div class="comments"></div> 199 200 <h4 id="_isadirectory_keyword__extra">_extra 201 202 203 204 205 206 207 208 209 </h4> 210 211 <div class="comments"></div> 212 213 214 215 216 217 218 219 197 <h3>Version history</h3> 198 199 200 <h4>History</h4><div class="value"> Sebastien Masson (smasson@lodyc.jussieu.fr) 201 June 28, 2000 202 June 2005: Sebastien Masson: cleaning, use for file_* functions</div> 220 203 221 204 -
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 -
trunk/SRC/Documentation/idldoc_html_output/Utilities/protype.html
r89 r93 102 102 <div class="routine_details" id="_protype"> 103 103 104 <h2><a class="top" href="#container">top</a>protype </h2> 104 <h2><a class="top" href="#container">top</a>protype <span class="categories"> utilities 105 </span></h2> 105 106 106 107 <p class="header"> … … 108 109 109 110 <div class="comments"> 110 NAME: protype 111 test is a ".pro" file corresponds to an IDL procedure, 112 function or batch file. 113 </div> 111 114 112 PURPOSE: test is a ".pro" file corresponds to an IDL procedure, 113 function or batch file. 115 <h3>Return value</h3><div class="value"> A scalar of string type: 'proc', 'func' or 'batch' 116 </div> 114 117 115 CATEGORY: 118 119 <h3>Parameters</h3> 120 121 122 <h4 id="_protype_param_file">file 123 <span class="attr">in</span> 124 125 126 127 128 129 130 131 </h4> 132 133 <div class="comments"> A scalar of string type, the name of the ".pro" file to be tested 134 if necessary, the input name is completed with '.pro' 135 and its path found in !path 136 </div> 137 116 138 117 CALLING SEQUENCE: type = protype(profilename) 139 118 140 119 INPUTS: A scalar of string type, the name of the ".pro" file to be tested 120 if necessary, the input name is completed with '.pro' 121 and its path found in !path 141 122 142 123 KEYWORD PARAMETERS: NONE 124 125 OUTPUTS: A scalar of string type: 'proc', 'func' or 'batch' 126 127 COMMON BLOCKS: none 128 129 SIDE EFFECTS: 130 131 RESTRICTIONS: 132 133 EXAMPLE: 143 <h3>Examples</h3><div class="value"> 134 144 135 145 IDL> print, protype('protype') … … 142 152 proc 143 153 </div> 144 145 146 147 148 <h3>Parameters</h3> 149 150 151 <h4 id="_protype_param_file">file 152 153 154 155 156 157 158 159 160 </h4> 161 162 <div class="comments"></div> 163 164 165 166 167 168 154 <h3>Version history</h3> 169 155 170 156 171 172 173 157 <h4>History</h4><div class="value"> Sebastien Masson (smasson@lodyc.jussieu.fr) 158 Feb 2006</div> 174 159 175 160
Note: See TracChangeset
for help on using the changeset viewer.
