| 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>getfile.pro (SAXO 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="getfile.pro (SAXO Documentation)"; |
|---|
| 19 | } |
|---|
| 20 | </script> |
|---|
| 21 | </head> |
|---|
| 22 | |
|---|
| 23 | <body onload="setTitle();"> |
|---|
| 24 | |
|---|
| 25 | <div id="navbar_title"> |
|---|
| 26 | <h1>SAXO 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" title="Overview of library">Overview</a></td> |
|---|
| 36 | |
|---|
| 37 | |
|---|
| 38 | |
|---|
| 39 | <td >Directory</td> |
|---|
| 40 | |
|---|
| 41 | |
|---|
| 42 | |
|---|
| 43 | <td><a href="./../../idldoc-categories.html" title="Browse library by category">Categories</a></td> |
|---|
| 44 | |
|---|
| 45 | |
|---|
| 46 | |
|---|
| 47 | <td><a href="./../../idldoc-index.html" title="Index of files, routines, and parameters">Index</a></td> |
|---|
| 48 | |
|---|
| 49 | |
|---|
| 50 | |
|---|
| 51 | <td><a href="./../../search-page.html" title="Search library">Search</a></td> |
|---|
| 52 | |
|---|
| 53 | |
|---|
| 54 | <td id="selected">File</td> |
|---|
| 55 | |
|---|
| 56 | |
|---|
| 57 | <td><a href="../../../../ToBeReviewed/STRING//getfile.pro" title="Source code of a file">Source</a></td> |
|---|
| 58 | |
|---|
| 59 | |
|---|
| 60 | |
|---|
| 61 | <td><a href="./../../idldoc-help.html" 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="delchr.html"><<prev file</a> | <a href="getwrd.html">next file >></a> <a href="getfile.html" target="_TOP">view single page</a> | <a href="./../../index.html" 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">ToBeReviewed/STRING/</a></h1> |
|---|
| 82 | <h2 class="pro_file">getfile.pro</h2> |
|---|
| 83 | |
|---|
| 84 | <div id="file_attr"> |
|---|
| 85 | <dl> |
|---|
| 86 | </dl> |
|---|
| 87 | </div> |
|---|
| 88 | |
|---|
| 89 | <div id="file_comments"> |
|---|
| 90 | Read a text file into a string array. |
|---|
| 91 | </div> |
|---|
| 92 | |
|---|
| 93 | |
|---|
| 94 | |
|---|
| 95 | |
|---|
| 96 | |
|---|
| 97 | |
|---|
| 98 | |
|---|
| 99 | |
|---|
| 100 | |
|---|
| 101 | <div id="routine_details"> |
|---|
| 102 | |
|---|
| 103 | |
|---|
| 104 | <div class="routine_details" id="_getfile"> |
|---|
| 105 | |
|---|
| 106 | <h2><a class="top" href="#container">top</a>getfile </h2> |
|---|
| 107 | |
|---|
| 108 | <p class="header"> |
|---|
| 109 | <span class="result">result = </span>getfile(<span class="result"><a href="#_getfile_param_filein">filein</a></span>, <a href="#_getfile_keyword_ERROR">ERROR</a>=<span class="result">ERROR</span>, <a href="#_getfile_keyword_HELP">HELP</a>=<span class="result">HELP</span>, <a href="#_getfile_keyword_QUIET">QUIET</a>=<span class="result">QUIET</span>, <a href="#_getfile_keyword_LINES">LINES</a>=<span class="result">LINES</span>, <a href="#_getfile_keyword_FIND">FIND</a>=<span class="result">FIND</span>)</p> |
|---|
| 110 | |
|---|
| 111 | <div class="comments"> |
|---|
| 112 | </div> |
|---|
| 113 | |
|---|
| 114 | <h3>Return value</h3><div class="preformat"> |
|---|
| 115 | </div> |
|---|
| 116 | |
|---|
| 117 | |
|---|
| 118 | <h3>Parameters</h3> |
|---|
| 119 | |
|---|
| 120 | |
|---|
| 121 | <h4 id="_getfile_param_filein">filein |
|---|
| 122 | <span class="attr">in</span> |
|---|
| 123 | |
|---|
| 124 | |
|---|
| 125 | <span class="attr">required</span> |
|---|
| 126 | |
|---|
| 127 | |
|---|
| 128 | |
|---|
| 129 | |
|---|
| 130 | </h4> |
|---|
| 131 | |
|---|
| 132 | <div class="comments"> |
|---|
| 133 | text file name. |
|---|
| 134 | </div> |
|---|
| 135 | |
|---|
| 136 | |
|---|
| 137 | |
|---|
| 138 | |
|---|
| 139 | |
|---|
| 140 | |
|---|
| 141 | <h3>Keywords</h3> |
|---|
| 142 | |
|---|
| 143 | <h4 id="_getfile_keyword_ERROR">ERROR |
|---|
| 144 | |
|---|
| 145 | |
|---|
| 146 | |
|---|
| 147 | |
|---|
| 148 | |
|---|
| 149 | |
|---|
| 150 | |
|---|
| 151 | |
|---|
| 152 | </h4> |
|---|
| 153 | |
|---|
| 154 | <div class="comments"> |
|---|
| 155 | error flag: 0=ok, 1=file not opened, 2=no lines in file. |
|---|
| 156 | </div> |
|---|
| 157 | |
|---|
| 158 | <h4 id="_getfile_keyword_HELP">HELP |
|---|
| 159 | |
|---|
| 160 | |
|---|
| 161 | |
|---|
| 162 | |
|---|
| 163 | |
|---|
| 164 | |
|---|
| 165 | |
|---|
| 166 | |
|---|
| 167 | </h4> |
|---|
| 168 | |
|---|
| 169 | <div class="comments"> |
|---|
| 170 | </div> |
|---|
| 171 | |
|---|
| 172 | <h4 id="_getfile_keyword_QUIET">QUIET |
|---|
| 173 | |
|---|
| 174 | |
|---|
| 175 | |
|---|
| 176 | |
|---|
| 177 | |
|---|
| 178 | |
|---|
| 179 | |
|---|
| 180 | |
|---|
| 181 | </h4> |
|---|
| 182 | |
|---|
| 183 | <div class="comments"> |
|---|
| 184 | means give no error message. |
|---|
| 185 | </div> |
|---|
| 186 | |
|---|
| 187 | <h4 id="_getfile_keyword_LINES">LINES |
|---|
| 188 | |
|---|
| 189 | |
|---|
| 190 | |
|---|
| 191 | |
|---|
| 192 | |
|---|
| 193 | |
|---|
| 194 | |
|---|
| 195 | |
|---|
| 196 | </h4> |
|---|
| 197 | |
|---|
| 198 | <div class="comments"> |
|---|
| 199 | Number of lines to read (def=all). |
|---|
| 200 | Much faster if number of lines is known. |
|---|
| 201 | Automatic for IDL 5.6 or later. |
|---|
| 202 | </div> |
|---|
| 203 | |
|---|
| 204 | <h4 id="_getfile_keyword_FIND">FIND |
|---|
| 205 | |
|---|
| 206 | |
|---|
| 207 | |
|---|
| 208 | |
|---|
| 209 | |
|---|
| 210 | |
|---|
| 211 | |
|---|
| 212 | |
|---|
| 213 | </h4> |
|---|
| 214 | |
|---|
| 215 | <div class="comments"> |
|---|
| 216 | search the file in the all !path directories (use <a href="../..//Utilities/find.html">find</a>) |
|---|
| 217 | </div> |
|---|
| 218 | |
|---|
| 219 | |
|---|
| 220 | |
|---|
| 221 | |
|---|
| 222 | <h3>Version history</h3> |
|---|
| 223 | |
|---|
| 224 | <h4>Version</h4><div class="preformat"> |
|---|
| 225 | $Id: getfile.pro 374 2008-08-08 15:12:27Z pinsard $ |
|---|
| 226 | </div> |
|---|
| 227 | <h4>History</h4><div class="preformat"> |
|---|
| 228 | - R. Sterner, 20 Mar, 1990 |
|---|
| 229 | - R. Sterner, 1999 Apr 14 --- Added LINES=n keyword. |
|---|
| 230 | - R. Sterner, 2003 Aug 29 --- Automatic lines if IDL 5.6+. |
|---|
| 231 | - R. Sterner, 2003 Sep 02 --- Check if file exists first. |
|---|
| 232 | - R. Sterner, 2003 Sep 04 --- Fixed error in number of lines in file. |
|---|
| 233 | - R. Sterner, 2003 Oct 10 --- Fixed error when no lines. |
|---|
| 234 | - R. Sterner, 2004 Jan 27 --- Fixed to work in IDL as old as vers 4. |
|---|
| 235 | - S. Masson (smasson@lodyc.jussieu.fr) 4 Feb 2002 |
|---|
| 236 | |
|---|
| 237 | search the file in the all !path directories (use <a href="../..//Utilities/find.html">find</a>) |
|---|
| 238 | when using /find keyword. Use <a href="/Applications/itt/idl64/help/online_help/SPAWN.html">SPAWN</a>, 'cat...' for |
|---|
| 239 | unix os. |
|---|
| 240 | |
|---|
| 241 | Copyright (C) 1990, Johns Hopkins University/Applied Physics Laboratory |
|---|
| 242 | This software may be used, copied, or redistributed as long as it is not |
|---|
| 243 | sold and this copyright notice is reproduced on each copy made. This |
|---|
| 244 | routine is provided as is without any express or implied warranties |
|---|
| 245 | whatsoever. Other limitations apply as described in the file disclaimer.txt. |
|---|
| 246 | </div> |
|---|
| 247 | |
|---|
| 248 | |
|---|
| 249 | |
|---|
| 250 | |
|---|
| 251 | |
|---|
| 252 | |
|---|
| 253 | |
|---|
| 254 | |
|---|
| 255 | |
|---|
| 256 | |
|---|
| 257 | |
|---|
| 258 | |
|---|
| 259 | |
|---|
| 260 | |
|---|
| 261 | |
|---|
| 262 | |
|---|
| 263 | <h3>Statistics</h3> |
|---|
| 264 | <table class="statistics"> |
|---|
| 265 | <tr><td>McCabe cyclic</td><td> 17</td></tr> |
|---|
| 266 | <tr><td>McCabe essential</td><td> 1</td></tr> |
|---|
| 267 | <tr><td>McCabe modular design</td><td> 1</td></tr> |
|---|
| 268 | </table> |
|---|
| 269 | |
|---|
| 270 | |
|---|
| 271 | </div> |
|---|
| 272 | |
|---|
| 273 | </div> |
|---|
| 274 | |
|---|
| 275 | |
|---|
| 276 | |
|---|
| 277 | <div id="tagline">Produced by IDLdoc 2.0.</div> |
|---|
| 278 | |
|---|
| 279 | </div> |
|---|
| 280 | |
|---|
| 281 | </body> |
|---|
| 282 | </html> |
|---|
