| 1 | |
|---|
| 2 | |
|---|
| 3 | <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> |
|---|
| 4 | <head> |
|---|
| 5 | <title>read_ftp.pro (SAXO Documentation Assistant)</title> |
|---|
| 6 | </head> |
|---|
| 7 | |
|---|
| 8 | <body text="#000000" bgcolor="#FFFFFF"> |
|---|
| 9 | |
|---|
| 10 | |
|---|
| 11 | <!-- Navbar template takes a structure with the following fields: |
|---|
| 12 | overview_href : |
|---|
| 13 | overview_selected : |
|---|
| 14 | dir_overview_href : |
|---|
| 15 | dir_overview_selected : |
|---|
| 16 | categories_href : |
|---|
| 17 | categories_selected : |
|---|
| 18 | index_href : |
|---|
| 19 | index_selected : |
|---|
| 20 | search_href : |
|---|
| 21 | search_selected : |
|---|
| 22 | file_selected : |
|---|
| 23 | source_href : |
|---|
| 24 | source_selected : |
|---|
| 25 | help_href : |
|---|
| 26 | help_selected : |
|---|
| 27 | etc_selected : |
|---|
| 28 | |
|---|
| 29 | prev_file_href : |
|---|
| 30 | next_file_href : |
|---|
| 31 | |
|---|
| 32 | view_single_page_href : |
|---|
| 33 | view_frames_href : |
|---|
| 34 | |
|---|
| 35 | summary_fields_href : |
|---|
| 36 | summary_routine_href : |
|---|
| 37 | details_routine_href : |
|---|
| 38 | |
|---|
| 39 | title : |
|---|
| 40 | subtitle : |
|---|
| 41 | user : |
|---|
| 42 | --> |
|---|
| 43 | |
|---|
| 44 | |
|---|
| 45 | <table border="0" cellpadding="0" cellspacing="0" width="98%" bgcolor="#F0F0FF" valign="bottom"> |
|---|
| 46 | <tr> |
|---|
| 47 | <td width="10%"> |
|---|
| 48 | <a href="ncdf_lec.html"><img src="./../../prev.gif" border="0" alt="Previous"></a></td> |
|---|
| 49 | <td width="80%" align="center" valign="center"> |
|---|
| 50 | <font size=-1><i>SAXO Documentation Assistant</i>: <a href="./../../home.html">Overview</a></font></td> |
|---|
| 51 | <td width="10%" align="right"> |
|---|
| 52 | <a href="read_ncdf.html"><img src="./../../next.gif" border="0" alt="Next"></a></td> |
|---|
| 53 | </tr> |
|---|
| 54 | </table> |
|---|
| 55 | |
|---|
| 56 | |
|---|
| 57 | <h1><font size="-2">ToBeReviewed/LECTURE/</font></h1> |
|---|
| 58 | <h2>read_ftp.pro</h2> |
|---|
| 59 | |
|---|
| 60 | <dl> |
|---|
| 61 | </dl> |
|---|
| 62 | |
|---|
| 63 | |
|---|
| 64 | |
|---|
| 65 | |
|---|
| 66 | |
|---|
| 67 | |
|---|
| 68 | READ_FTP, remote_host [, files] [, directory] [,/FILE] [,DATA=variable] |
|---|
| 69 | [,USER=string] [,PASS=string] [,/PTR] |
|---|
| 70 | |
|---|
| 71 | |
|---|
| 72 | |
|---|
| 73 | <h2>Routine summary</h2> |
|---|
| 74 | |
|---|
| 75 | <dl> |
|---|
| 76 | |
|---|
| 77 | <dt><a href="#_ftp_post">ftp_post<i>, u, cmd, res</i>, out=<i>out</i>, count=<i>count</i></a><dt> |
|---|
| 78 | <dd><font size="-1"> </font></dd> |
|---|
| 79 | |
|---|
| 80 | <dt><a href="#_ftp_parse_pasv">ftp_parse_pasv<i>, text, host, port</i></a><dt> |
|---|
| 81 | <dd><font size="-1"> </font></dd> |
|---|
| 82 | |
|---|
| 83 | <dt><a href="#_read_ftp">read_ftp<i>, site, files, dir, port</i>, data=<i>data</i>, file=<i>file</i>, user=<i>user</i>, pass=<i>pass</i>, ptr=<i>ptr</i></a><dt> |
|---|
| 84 | <dd><font size="-1"> </font></dd> |
|---|
| 85 | |
|---|
| 86 | </dl> |
|---|
| 87 | |
|---|
| 88 | <p> </p> |
|---|
| 89 | |
|---|
| 90 | |
|---|
| 91 | |
|---|
| 92 | <a name="#_ftp_post"></a> |
|---|
| 93 | |
|---|
| 94 | <h2>ftp_post <font size="-1" color="#006633"> |
|---|
| 95 | </font></h2> |
|---|
| 96 | |
|---|
| 97 | <p><font face="Courier">ftp_post<i>, <a href="#_ftp_post_keyword_u">u</a>, <a href="#_ftp_post_keyword_cmd">cmd</a>, <a href="#_ftp_post_keyword_res">res</a></i>, <a href="#_ftp_post_keyword_out">out</a>=<i>out</i>, <a href="#_ftp_post_keyword_count">count</a>=<i>count</i></font></p> |
|---|
| 98 | |
|---|
| 99 | |
|---|
| 100 | |
|---|
| 101 | |
|---|
| 102 | |
|---|
| 103 | |
|---|
| 104 | |
|---|
| 105 | <h3>Parameters</h3> |
|---|
| 106 | |
|---|
| 107 | |
|---|
| 108 | <a name="#_ftp_post_keyword_u"></a> |
|---|
| 109 | <h4>u |
|---|
| 110 | |
|---|
| 111 | |
|---|
| 112 | |
|---|
| 113 | |
|---|
| 114 | |
|---|
| 115 | |
|---|
| 116 | |
|---|
| 117 | |
|---|
| 118 | </h4> |
|---|
| 119 | |
|---|
| 120 | |
|---|
| 121 | |
|---|
| 122 | |
|---|
| 123 | |
|---|
| 124 | <a name="#_ftp_post_keyword_cmd"></a> |
|---|
| 125 | <h4>cmd |
|---|
| 126 | |
|---|
| 127 | |
|---|
| 128 | |
|---|
| 129 | |
|---|
| 130 | |
|---|
| 131 | |
|---|
| 132 | |
|---|
| 133 | |
|---|
| 134 | </h4> |
|---|
| 135 | |
|---|
| 136 | |
|---|
| 137 | |
|---|
| 138 | |
|---|
| 139 | |
|---|
| 140 | <a name="#_ftp_post_keyword_res"></a> |
|---|
| 141 | <h4>res |
|---|
| 142 | |
|---|
| 143 | |
|---|
| 144 | |
|---|
| 145 | |
|---|
| 146 | |
|---|
| 147 | |
|---|
| 148 | |
|---|
| 149 | |
|---|
| 150 | </h4> |
|---|
| 151 | |
|---|
| 152 | |
|---|
| 153 | |
|---|
| 154 | |
|---|
| 155 | |
|---|
| 156 | |
|---|
| 157 | |
|---|
| 158 | <h3>Keywords</h3> |
|---|
| 159 | |
|---|
| 160 | |
|---|
| 161 | <a name="#_ftp_post_keyword_out"></a> |
|---|
| 162 | <h4>out |
|---|
| 163 | |
|---|
| 164 | |
|---|
| 165 | |
|---|
| 166 | |
|---|
| 167 | |
|---|
| 168 | |
|---|
| 169 | |
|---|
| 170 | |
|---|
| 171 | </h4> |
|---|
| 172 | |
|---|
| 173 | |
|---|
| 174 | |
|---|
| 175 | |
|---|
| 176 | <a name="#_ftp_post_keyword_count"></a> |
|---|
| 177 | <h4>count |
|---|
| 178 | |
|---|
| 179 | |
|---|
| 180 | |
|---|
| 181 | |
|---|
| 182 | |
|---|
| 183 | |
|---|
| 184 | |
|---|
| 185 | |
|---|
| 186 | </h4> |
|---|
| 187 | |
|---|
| 188 | |
|---|
| 189 | Upon return, the number of elements in the result set. |
|---|
| 190 | This is only important when the result set is the empty |
|---|
| 191 | set, in which case COUNT is set to zero. |
|---|
| 192 | |
|---|
| 193 | |
|---|
| 194 | |
|---|
| 195 | |
|---|
| 196 | <h3>Examples</h3><pre> |
|---|
| 197 | |
|---|
| 198 | </pre><h3>Version history</h3> |
|---|
| 199 | |
|---|
| 200 | <h4>Version</h4> |
|---|
| 201 | $Id: read_ftp.pro 231 2007-03-19 17:15:51Z pinsard $ |
|---|
| 202 | <h4>History</h4> |
|---|
| 203 | |
|---|
| 204 | |
|---|
| 205 | |
|---|
| 206 | <h3>Known issues</h3> |
|---|
| 207 | |
|---|
| 208 | |
|---|
| 209 | |
|---|
| 210 | <h4>Restrictions</h4> |
|---|
| 211 | |
|---|
| 212 | |
|---|
| 213 | |
|---|
| 214 | |
|---|
| 215 | |
|---|
| 216 | |
|---|
| 217 | |
|---|
| 218 | |
|---|
| 219 | |
|---|
| 220 | |
|---|
| 221 | <font size="-3"><p> </p></font> |
|---|
| 222 | <hr size="1" color="#CCCCCC"/> |
|---|
| 223 | |
|---|
| 224 | <a name="#_ftp_parse_pasv"></a> |
|---|
| 225 | |
|---|
| 226 | <h2>ftp_parse_pasv <font size="-1" color="#006633"> |
|---|
| 227 | </font></h2> |
|---|
| 228 | |
|---|
| 229 | <p><font face="Courier">ftp_parse_pasv<i>, <a href="#_ftp_parse_pasv_keyword_text">text</a>, <a href="#_ftp_parse_pasv_keyword_host">host</a>, <a href="#_ftp_parse_pasv_keyword_port">port</a></i></font></p> |
|---|
| 230 | |
|---|
| 231 | |
|---|
| 232 | |
|---|
| 233 | |
|---|
| 234 | |
|---|
| 235 | |
|---|
| 236 | |
|---|
| 237 | <h3>Parameters</h3> |
|---|
| 238 | |
|---|
| 239 | |
|---|
| 240 | <a name="#_ftp_parse_pasv_keyword_text"></a> |
|---|
| 241 | <h4>text |
|---|
| 242 | |
|---|
| 243 | |
|---|
| 244 | |
|---|
| 245 | |
|---|
| 246 | |
|---|
| 247 | |
|---|
| 248 | |
|---|
| 249 | |
|---|
| 250 | </h4> |
|---|
| 251 | |
|---|
| 252 | |
|---|
| 253 | ASCII text string containing the message. |
|---|
| 254 | |
|---|
| 255 | |
|---|
| 256 | |
|---|
| 257 | <a name="#_ftp_parse_pasv_keyword_host"></a> |
|---|
| 258 | <h4>host |
|---|
| 259 | |
|---|
| 260 | |
|---|
| 261 | |
|---|
| 262 | |
|---|
| 263 | |
|---|
| 264 | |
|---|
| 265 | |
|---|
| 266 | |
|---|
| 267 | </h4> |
|---|
| 268 | |
|---|
| 269 | |
|---|
| 270 | |
|---|
| 271 | |
|---|
| 272 | |
|---|
| 273 | <a name="#_ftp_parse_pasv_keyword_port"></a> |
|---|
| 274 | <h4>port |
|---|
| 275 | |
|---|
| 276 | |
|---|
| 277 | |
|---|
| 278 | |
|---|
| 279 | |
|---|
| 280 | |
|---|
| 281 | |
|---|
| 282 | |
|---|
| 283 | </h4> |
|---|
| 284 | |
|---|
| 285 | |
|---|
| 286 | |
|---|
| 287 | |
|---|
| 288 | |
|---|
| 289 | |
|---|
| 290 | |
|---|
| 291 | |
|---|
| 292 | <h3>Examples</h3><pre> |
|---|
| 293 | |
|---|
| 294 | </pre><h3>Version history</h3> |
|---|
| 295 | |
|---|
| 296 | <h4>Version</h4> |
|---|
| 297 | $Id: read_ftp.pro 231 2007-03-19 17:15:51Z pinsard $ |
|---|
| 298 | |
|---|
| 299 | <h4>History</h4> |
|---|
| 300 | |
|---|
| 301 | |
|---|
| 302 | |
|---|
| 303 | <h3>Known issues</h3> |
|---|
| 304 | |
|---|
| 305 | |
|---|
| 306 | |
|---|
| 307 | <h4>Restrictions</h4> |
|---|
| 308 | |
|---|
| 309 | |
|---|
| 310 | |
|---|
| 311 | |
|---|
| 312 | |
|---|
| 313 | |
|---|
| 314 | |
|---|
| 315 | |
|---|
| 316 | |
|---|
| 317 | |
|---|
| 318 | <font size="-3"><p> </p></font> |
|---|
| 319 | <hr size="1" color="#CCCCCC"/> |
|---|
| 320 | |
|---|
| 321 | <a name="#_read_ftp"></a> |
|---|
| 322 | |
|---|
| 323 | <h2>read_ftp </h2> |
|---|
| 324 | |
|---|
| 325 | <p><font face="Courier">read_ftp<i>, <a href="#_read_ftp_keyword_site">site</a>, <a href="#_read_ftp_keyword_files">files</a>, <a href="#_read_ftp_keyword_dir">dir</a>, <a href="#_read_ftp_keyword_port">port</a></i>, <a href="#_read_ftp_keyword_data">data</a>=<i>data</i>, <a href="#_read_ftp_keyword_file">file</a>=<i>file</i>, <a href="#_read_ftp_keyword_user">user</a>=<i>user</i>, <a href="#_read_ftp_keyword_pass">pass</a>=<i>pass</i>, <a href="#_read_ftp_keyword_ptr">ptr</a>=<i>ptr</i></font></p> |
|---|
| 326 | |
|---|
| 327 | |
|---|
| 328 | |
|---|
| 329 | |
|---|
| 330 | |
|---|
| 331 | |
|---|
| 332 | |
|---|
| 333 | <h3>Parameters</h3> |
|---|
| 334 | |
|---|
| 335 | |
|---|
| 336 | <a name="#_read_ftp_keyword_site"></a> |
|---|
| 337 | <h4>site |
|---|
| 338 | |
|---|
| 339 | |
|---|
| 340 | |
|---|
| 341 | |
|---|
| 342 | |
|---|
| 343 | |
|---|
| 344 | |
|---|
| 345 | |
|---|
| 346 | </h4> |
|---|
| 347 | |
|---|
| 348 | |
|---|
| 349 | |
|---|
| 350 | |
|---|
| 351 | <a name="#_read_ftp_keyword_files"></a> |
|---|
| 352 | <h4>files |
|---|
| 353 | |
|---|
| 354 | |
|---|
| 355 | |
|---|
| 356 | |
|---|
| 357 | |
|---|
| 358 | |
|---|
| 359 | |
|---|
| 360 | |
|---|
| 361 | </h4> |
|---|
| 362 | |
|---|
| 363 | |
|---|
| 364 | A single filename or an array of filenames to be retrieved. |
|---|
| 365 | |
|---|
| 366 | |
|---|
| 367 | |
|---|
| 368 | <a name="#_read_ftp_keyword_dir"></a> |
|---|
| 369 | <h4>dir |
|---|
| 370 | |
|---|
| 371 | |
|---|
| 372 | |
|---|
| 373 | |
|---|
| 374 | |
|---|
| 375 | |
|---|
| 376 | |
|---|
| 377 | |
|---|
| 378 | </h4> |
|---|
| 379 | |
|---|
| 380 | |
|---|
| 381 | Remote directory where the files reside on the ftp server |
|---|
| 382 | |
|---|
| 383 | |
|---|
| 384 | |
|---|
| 385 | <a name="#_read_ftp_keyword_port"></a> |
|---|
| 386 | <h4>port |
|---|
| 387 | |
|---|
| 388 | |
|---|
| 389 | |
|---|
| 390 | |
|---|
| 391 | |
|---|
| 392 | |
|---|
| 393 | |
|---|
| 394 | |
|---|
| 395 | </h4> |
|---|
| 396 | |
|---|
| 397 | |
|---|
| 398 | |
|---|
| 399 | |
|---|
| 400 | |
|---|
| 401 | |
|---|
| 402 | <h3>Keywords</h3> |
|---|
| 403 | |
|---|
| 404 | |
|---|
| 405 | <a name="#_read_ftp_keyword_data"></a> |
|---|
| 406 | <h4>data |
|---|
| 407 | |
|---|
| 408 | |
|---|
| 409 | |
|---|
| 410 | |
|---|
| 411 | |
|---|
| 412 | |
|---|
| 413 | |
|---|
| 414 | |
|---|
| 415 | </h4> |
|---|
| 416 | |
|---|
| 417 | |
|---|
| 418 | Set this to a named variable that will contain either a |
|---|
| 419 | byte array or an array of pointers to byte arrays with the |
|---|
| 420 | transferred data. If there is more than one file, an array |
|---|
| 421 | of pointers is returned, one for each file. |
|---|
| 422 | Note that when downloading large files using /FILE |
|---|
| 423 | instead will require much less memory since the entire file |
|---|
| 424 | is not stored in a variable in that case. |
|---|
| 425 | |
|---|
| 426 | |
|---|
| 427 | <a name="#_read_ftp_keyword_file"></a> |
|---|
| 428 | <h4>file |
|---|
| 429 | |
|---|
| 430 | |
|---|
| 431 | |
|---|
| 432 | |
|---|
| 433 | |
|---|
| 434 | |
|---|
| 435 | |
|---|
| 436 | |
|---|
| 437 | </h4> |
|---|
| 438 | |
|---|
| 439 | |
|---|
| 440 | Set this keyword to make a local copy of the file to be |
|---|
| 441 | transferred. The local file will have the same name as the |
|---|
| 442 | remote file and will be placed in the current working |
|---|
| 443 | directory. |
|---|
| 444 | |
|---|
| 445 | |
|---|
| 446 | <a name="#_read_ftp_keyword_user"></a> |
|---|
| 447 | <h4>user |
|---|
| 448 | |
|---|
| 449 | |
|---|
| 450 | |
|---|
| 451 | |
|---|
| 452 | |
|---|
| 453 | |
|---|
| 454 | |
|---|
| 455 | |
|---|
| 456 | </h4> |
|---|
| 457 | |
|---|
| 458 | |
|---|
| 459 | Specify user name to connect to server with. |
|---|
| 460 | |
|---|
| 461 | |
|---|
| 462 | <a name="#_read_ftp_keyword_pass"></a> |
|---|
| 463 | <h4>pass |
|---|
| 464 | |
|---|
| 465 | |
|---|
| 466 | |
|---|
| 467 | |
|---|
| 468 | |
|---|
| 469 | |
|---|
| 470 | |
|---|
| 471 | |
|---|
| 472 | </h4> |
|---|
| 473 | |
|---|
| 474 | |
|---|
| 475 | Specify password to use when connecting. |
|---|
| 476 | |
|---|
| 477 | |
|---|
| 478 | <a name="#_read_ftp_keyword_ptr"></a> |
|---|
| 479 | <h4>ptr |
|---|
| 480 | |
|---|
| 481 | |
|---|
| 482 | |
|---|
| 483 | |
|---|
| 484 | |
|---|
| 485 | |
|---|
| 486 | |
|---|
| 487 | |
|---|
| 488 | </h4> |
|---|
| 489 | |
|---|
| 490 | |
|---|
| 491 | Set this keyword to return an array of pointers |
|---|
| 492 | even when there is only one file. |
|---|
| 493 | |
|---|
| 494 | |
|---|
| 495 | |
|---|
| 496 | |
|---|
| 497 | <h3>Examples</h3><pre> |
|---|
| 498 | 1) Retrieve and print the contents of ftp://ftp.rsinc.com/pub/gzip/README.GZIP: |
|---|
| 499 | IDL> READ_FTP, 'ftp://ftp.rsinc.com/pub/gzip/README.GZIP', DATA=data |
|---|
| 500 | IDL> help, data |
|---|
| 501 | DATA BYTE = Array[2134] |
|---|
| 502 | IDL> print, string(data) |
|---|
| 503 | ------------------------------------------------------------------------------ |
|---|
| 504 | README file: Research Systems Anonymous FTP site (ftp.rsinc.com) |
|---|
| 505 | pub directory |
|---|
| 506 | gzip directory |
|---|
| 507 | ------------------------------------------------------------------------------ |
|---|
| 508 | ... |
|---|
| 509 | |
|---|
| 510 | 2) Retrieve some files from podaac.jpl.nasa.gov and store the files |
|---|
| 511 | in the current working directory: |
|---|
| 512 | |
|---|
| 513 | IDL> files = string(lindgen(10)+50,format='(%"MGB370.%3.3d.gz")') |
|---|
| 514 | IDL> READ_FTP, 'podaac.jpl.nasa.gov', files, $ |
|---|
| 515 | IDL> 'pub/sea_surface_height/topex_poseidon/mgdrb/data/MGB_370', /FILE |
|---|
| 516 | IDL> spawn,'dir MGB*',/log_output |
|---|
| 517 | Volume in drive C is Local Disk |
|---|
| 518 | Volume Serial Number is 34CE-24DF |
|---|
| 519 | |
|---|
| 520 | Directory of C:testtest0307 |
|---|
| 521 | |
|---|
| 522 | 07/28/2003 11:58a 362,167 MGB370.050.gz |
|---|
| 523 | 07/28/2003 11:58a 333,005 MGB370.051.gz |
|---|
| 524 | 07/28/2003 11:58a 310,287 MGB370.052.gz |
|---|
| 525 | 07/28/2003 11:58a 358,771 MGB370.053.gz |
|---|
| 526 | 07/28/2003 11:59a 387,282 MGB370.054.gz |
|---|
| 527 | 07/28/2003 11:59a 361,633 MGB370.055.gz |
|---|
| 528 | 07/28/2003 11:59a 383,075 MGB370.056.gz |
|---|
| 529 | 07/28/2003 11:59a 365,844 MGB370.057.gz |
|---|
| 530 | 07/28/2003 11:59a 383,918 MGB370.058.gz |
|---|
| 531 | 07/28/2003 12:00p 372,712 MGB370.059.gz |
|---|
| 532 | 10 File(s) 3,618,694 bytes |
|---|
| 533 | |
|---|
| 534 | These compressed files can consequently be opened with OPENR and the |
|---|
| 535 | /COMPRESSED keyword. |
|---|
| 536 | |
|---|
| 537 | </pre><h3>Version history</h3> |
|---|
| 538 | |
|---|
| 539 | <h4>Version</h4> |
|---|
| 540 | $Id: read_ftp.pro 231 2007-03-19 17:15:51Z pinsard $ |
|---|
| 541 | |
|---|
| 542 | <h4>History</h4> |
|---|
| 543 | |
|---|
| 544 | |
|---|
| 545 | |
|---|
| 546 | <h3>Known issues</h3> |
|---|
| 547 | |
|---|
| 548 | |
|---|
| 549 | <h4>Todo items</h4> |
|---|
| 550 | seb: que fait-on de "syntax" au debut du header? |
|---|
| 551 | give examples with date in year 0 (should not exists but may happen) |
|---|
| 552 | |
|---|
| 553 | |
|---|
| 554 | |
|---|
| 555 | |
|---|
| 556 | |
|---|
| 557 | |
|---|
| 558 | |
|---|
| 559 | |
|---|
| 560 | |
|---|
| 561 | |
|---|
| 562 | |
|---|
| 563 | <font size="-3"><p> </p></font> |
|---|
| 564 | <hr size="1" color="#CCCCCC"/> |
|---|
| 565 | |
|---|
| 566 | |
|---|
| 567 | |
|---|
| 568 | |
|---|
| 569 | <p><font color="gray" size="-3"> Produced by IDLdoc 2.0.</font></p> |
|---|
| 570 | |
|---|
| 571 | </body> |
|---|
| 572 | </html> |
|---|
