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>read_ftp.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="read_ftp.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/LECTURE//read_ftp.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="ncdf_lec.html"><<prev file</a> | <a href="read_ncdf.html">next file >></a> <a href="read_ftp.html" target="_TOP">view single page</a> | <a href="./../../index.html" target="_TOP">view frames</a> summary: fields | <a href="#routine_summary">routine</a> 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/LECTURE/</a></h1> |
---|
82 | <h2 class="pro_file">read_ftp.pro</h2> |
---|
83 | |
---|
84 | <div id="file_attr"> |
---|
85 | <dl> |
---|
86 | </dl> |
---|
87 | </div> |
---|
88 | |
---|
89 | <div id="file_comments"> |
---|
90 | |
---|
91 | |
---|
92 | |
---|
93 | |
---|
94 | READ_FTP, remote_host [, files] [, directory] [,/FILE] [,DATA=variable] |
---|
95 | [,USER=string] [,PASS=string] [,/PTR] |
---|
96 | </div> |
---|
97 | |
---|
98 | |
---|
99 | |
---|
100 | |
---|
101 | |
---|
102 | |
---|
103 | |
---|
104 | |
---|
105 | <div id="routine_summary"> |
---|
106 | <h2>Routine summary</h2> |
---|
107 | |
---|
108 | <dl> |
---|
109 | |
---|
110 | <dt><p><a href="#_ftp_post">ftp_post<span class="result">, u, cmd, res</span>, out=<span class="result">out</span>, count=<span class="result">count</span></a></p><dt> |
---|
111 | <dd> </dd> |
---|
112 | |
---|
113 | <dt><p><a href="#_ftp_parse_pasv">ftp_parse_pasv<span class="result">, text, host, port</span></a></p><dt> |
---|
114 | <dd> </dd> |
---|
115 | |
---|
116 | <dt><p><a href="#_read_ftp">read_ftp<span class="result">, site, files, dir, port</span>, data=<span class="result">data</span>, file=<span class="result">file</span>, user=<span class="result">user</span>, pass=<span class="result">pass</span>, ptr=<span class="result">ptr</span></a></p><dt> |
---|
117 | <dd> </dd> |
---|
118 | |
---|
119 | </dl> |
---|
120 | </div> |
---|
121 | |
---|
122 | |
---|
123 | <div id="routine_details"> |
---|
124 | |
---|
125 | |
---|
126 | <div class="routine_details" id="_ftp_post"> |
---|
127 | |
---|
128 | <h2><a class="top" href="#container">top</a>ftp_post <span class="categories"> |
---|
129 | </span></h2> |
---|
130 | |
---|
131 | <p class="header"> |
---|
132 | ftp_post<span class="result">, <a href="#_ftp_post_param_u">u</a>, <a href="#_ftp_post_param_cmd">cmd</a>, <a href="#_ftp_post_param_res">res</a></span>, <a href="#_ftp_post_keyword_out">out</a>=<span class="result">out</span>, <a href="#_ftp_post_keyword_count">count</a>=<span class="result">count</span></p> |
---|
133 | |
---|
134 | <div class="comments"> |
---|
135 | </div> |
---|
136 | |
---|
137 | |
---|
138 | |
---|
139 | |
---|
140 | <h3>Parameters</h3> |
---|
141 | |
---|
142 | |
---|
143 | <h4 id="_ftp_post_param_u">u |
---|
144 | |
---|
145 | |
---|
146 | |
---|
147 | |
---|
148 | |
---|
149 | |
---|
150 | |
---|
151 | |
---|
152 | </h4> |
---|
153 | |
---|
154 | <div class="comments"> |
---|
155 | </div> |
---|
156 | |
---|
157 | <h4 id="_ftp_post_param_cmd">cmd |
---|
158 | |
---|
159 | |
---|
160 | |
---|
161 | |
---|
162 | |
---|
163 | |
---|
164 | |
---|
165 | |
---|
166 | </h4> |
---|
167 | |
---|
168 | <div class="comments"> |
---|
169 | </div> |
---|
170 | |
---|
171 | <h4 id="_ftp_post_param_res">res |
---|
172 | |
---|
173 | |
---|
174 | |
---|
175 | |
---|
176 | |
---|
177 | |
---|
178 | |
---|
179 | |
---|
180 | </h4> |
---|
181 | |
---|
182 | <div class="comments"> |
---|
183 | </div> |
---|
184 | |
---|
185 | |
---|
186 | |
---|
187 | |
---|
188 | |
---|
189 | |
---|
190 | <h3>Keywords</h3> |
---|
191 | |
---|
192 | <h4 id="_ftp_post_keyword_out">out |
---|
193 | |
---|
194 | |
---|
195 | |
---|
196 | |
---|
197 | |
---|
198 | |
---|
199 | |
---|
200 | |
---|
201 | </h4> |
---|
202 | |
---|
203 | <div class="comments"> |
---|
204 | </div> |
---|
205 | |
---|
206 | <h4 id="_ftp_post_keyword_count">count |
---|
207 | |
---|
208 | |
---|
209 | |
---|
210 | |
---|
211 | |
---|
212 | |
---|
213 | |
---|
214 | |
---|
215 | </h4> |
---|
216 | |
---|
217 | <div class="comments"> |
---|
218 | Upon return, the number of elements in the result set. |
---|
219 | This is only important when the result set is the empty |
---|
220 | set, in which case COUNT is set to zero. |
---|
221 | </div> |
---|
222 | |
---|
223 | |
---|
224 | |
---|
225 | <h3>Examples</h3><div class="preformat"> |
---|
226 | </div> |
---|
227 | <h3>Version history</h3> |
---|
228 | |
---|
229 | <h4>Version</h4><div class="preformat"> |
---|
230 | $Id: read_ftp.pro 371 2008-08-07 09:32:02Z pinsard $ |
---|
231 | </div> |
---|
232 | <h4>History</h4><div class="preformat"> |
---|
233 | </div> |
---|
234 | |
---|
235 | |
---|
236 | <h3>Known issues</h3> |
---|
237 | |
---|
238 | |
---|
239 | |
---|
240 | <h4>Restrictions</h4><div class="preformat"> |
---|
241 | </div> |
---|
242 | |
---|
243 | |
---|
244 | |
---|
245 | |
---|
246 | |
---|
247 | |
---|
248 | |
---|
249 | |
---|
250 | |
---|
251 | <h3>Statistics</h3> |
---|
252 | <table class="statistics"> |
---|
253 | <tr><td>McCabe cyclic</td><td> 7</td></tr> |
---|
254 | <tr><td>McCabe essential</td><td> 3</td></tr> |
---|
255 | <tr><td>McCabe modular design</td><td> 1</td></tr> |
---|
256 | </table> |
---|
257 | |
---|
258 | |
---|
259 | </div> |
---|
260 | |
---|
261 | |
---|
262 | <div class="routine_details" id="_ftp_parse_pasv"> |
---|
263 | |
---|
264 | <h2><a class="top" href="#container">top</a>ftp_parse_pasv <span class="categories"> |
---|
265 | </span></h2> |
---|
266 | |
---|
267 | <p class="header"> |
---|
268 | ftp_parse_pasv<span class="result">, <a href="#_ftp_parse_pasv_param_text">text</a>, <a href="#_ftp_parse_pasv_param_host">host</a>, <a href="#_ftp_parse_pasv_param_port">port</a></span></p> |
---|
269 | |
---|
270 | <div class="comments"> |
---|
271 | </div> |
---|
272 | |
---|
273 | |
---|
274 | |
---|
275 | |
---|
276 | <h3>Parameters</h3> |
---|
277 | |
---|
278 | |
---|
279 | <h4 id="_ftp_parse_pasv_param_text">text |
---|
280 | |
---|
281 | |
---|
282 | |
---|
283 | |
---|
284 | |
---|
285 | |
---|
286 | |
---|
287 | |
---|
288 | </h4> |
---|
289 | |
---|
290 | <div class="comments"> |
---|
291 | ASCII text string containing the message. |
---|
292 | </div> |
---|
293 | |
---|
294 | <h4 id="_ftp_parse_pasv_param_host">host |
---|
295 | |
---|
296 | |
---|
297 | |
---|
298 | |
---|
299 | |
---|
300 | |
---|
301 | |
---|
302 | |
---|
303 | </h4> |
---|
304 | |
---|
305 | <div class="comments"> |
---|
306 | </div> |
---|
307 | |
---|
308 | <h4 id="_ftp_parse_pasv_param_port">port |
---|
309 | |
---|
310 | |
---|
311 | |
---|
312 | |
---|
313 | |
---|
314 | |
---|
315 | |
---|
316 | |
---|
317 | </h4> |
---|
318 | |
---|
319 | <div class="comments"> |
---|
320 | </div> |
---|
321 | |
---|
322 | |
---|
323 | |
---|
324 | |
---|
325 | |
---|
326 | |
---|
327 | <h3>Examples</h3><div class="preformat"> |
---|
328 | </div> |
---|
329 | <h3>Version history</h3> |
---|
330 | |
---|
331 | <h4>Version</h4><div class="preformat"> |
---|
332 | $Id: read_ftp.pro 371 2008-08-07 09:32:02Z pinsard $ |
---|
333 | </div> |
---|
334 | <h4>History</h4><div class="preformat"> |
---|
335 | </div> |
---|
336 | |
---|
337 | |
---|
338 | <h3>Known issues</h3> |
---|
339 | |
---|
340 | |
---|
341 | |
---|
342 | <h4>Restrictions</h4><div class="preformat"> |
---|
343 | </div> |
---|
344 | |
---|
345 | |
---|
346 | |
---|
347 | |
---|
348 | |
---|
349 | |
---|
350 | |
---|
351 | |
---|
352 | |
---|
353 | <h3>Statistics</h3> |
---|
354 | <table class="statistics"> |
---|
355 | <tr><td>McCabe cyclic</td><td> 2</td></tr> |
---|
356 | <tr><td>McCabe essential</td><td> 1</td></tr> |
---|
357 | <tr><td>McCabe modular design</td><td> 1</td></tr> |
---|
358 | </table> |
---|
359 | |
---|
360 | |
---|
361 | </div> |
---|
362 | |
---|
363 | |
---|
364 | <div class="routine_details" id="_read_ftp"> |
---|
365 | |
---|
366 | <h2><a class="top" href="#container">top</a>read_ftp </h2> |
---|
367 | |
---|
368 | <p class="header"> |
---|
369 | read_ftp<span class="result">, <a href="#_read_ftp_param_site">site</a>, <a href="#_read_ftp_param_files">files</a>, <a href="#_read_ftp_param_dir">dir</a>, <a href="#_read_ftp_param_port">port</a></span>, <a href="#_read_ftp_keyword_data">data</a>=<span class="result">data</span>, <a href="#_read_ftp_keyword_file">file</a>=<span class="result">file</span>, <a href="#_read_ftp_keyword_user">user</a>=<span class="result">user</span>, <a href="#_read_ftp_keyword_pass">pass</a>=<span class="result">pass</span>, <a href="#_read_ftp_keyword_ptr">ptr</a>=<span class="result">ptr</span></p> |
---|
370 | |
---|
371 | <div class="comments"> |
---|
372 | </div> |
---|
373 | |
---|
374 | |
---|
375 | |
---|
376 | |
---|
377 | <h3>Parameters</h3> |
---|
378 | |
---|
379 | |
---|
380 | <h4 id="_read_ftp_param_site">site |
---|
381 | |
---|
382 | |
---|
383 | |
---|
384 | |
---|
385 | |
---|
386 | |
---|
387 | |
---|
388 | |
---|
389 | </h4> |
---|
390 | |
---|
391 | <div class="comments"></div> |
---|
392 | |
---|
393 | <h4 id="_read_ftp_param_files">files |
---|
394 | |
---|
395 | |
---|
396 | |
---|
397 | |
---|
398 | |
---|
399 | |
---|
400 | |
---|
401 | |
---|
402 | </h4> |
---|
403 | |
---|
404 | <div class="comments"> |
---|
405 | A single filename or an array of filenames to be retrieved. |
---|
406 | </div> |
---|
407 | |
---|
408 | <h4 id="_read_ftp_param_dir">dir |
---|
409 | |
---|
410 | |
---|
411 | |
---|
412 | |
---|
413 | |
---|
414 | |
---|
415 | |
---|
416 | |
---|
417 | </h4> |
---|
418 | |
---|
419 | <div class="comments"> |
---|
420 | Remote directory where the files reside on the ftp server |
---|
421 | </div> |
---|
422 | |
---|
423 | <h4 id="_read_ftp_param_port">port |
---|
424 | |
---|
425 | |
---|
426 | |
---|
427 | |
---|
428 | |
---|
429 | |
---|
430 | |
---|
431 | |
---|
432 | </h4> |
---|
433 | |
---|
434 | <div class="comments"></div> |
---|
435 | |
---|
436 | |
---|
437 | |
---|
438 | |
---|
439 | |
---|
440 | |
---|
441 | <h3>Keywords</h3> |
---|
442 | |
---|
443 | <h4 id="_read_ftp_keyword_data">data |
---|
444 | |
---|
445 | |
---|
446 | |
---|
447 | |
---|
448 | |
---|
449 | |
---|
450 | |
---|
451 | |
---|
452 | </h4> |
---|
453 | |
---|
454 | <div class="comments"> |
---|
455 | Set this to a named variable that will contain either a |
---|
456 | byte array or an array of pointers to byte arrays with the |
---|
457 | transferred data. If there is more than one file, an array |
---|
458 | of pointers is returned, one for each file. |
---|
459 | Note that when downloading large files using /FILE |
---|
460 | instead will require much less memory since the entire file |
---|
461 | is not stored in a variable in that case. |
---|
462 | </div> |
---|
463 | |
---|
464 | <h4 id="_read_ftp_keyword_file">file |
---|
465 | |
---|
466 | |
---|
467 | |
---|
468 | |
---|
469 | |
---|
470 | |
---|
471 | |
---|
472 | |
---|
473 | </h4> |
---|
474 | |
---|
475 | <div class="comments"> |
---|
476 | Set this keyword to make a local copy of the file to be |
---|
477 | transferred. The local file will have the same name as the |
---|
478 | remote file and will be placed in the current working |
---|
479 | directory. |
---|
480 | </div> |
---|
481 | |
---|
482 | <h4 id="_read_ftp_keyword_user">user |
---|
483 | |
---|
484 | |
---|
485 | |
---|
486 | |
---|
487 | |
---|
488 | |
---|
489 | <span class="attr">default:</span> <span class="value">anonymous</span> |
---|
490 | |
---|
491 | </h4> |
---|
492 | |
---|
493 | <div class="comments"> |
---|
494 | Specify user name to connect to server with. |
---|
495 | </div> |
---|
496 | |
---|
497 | <h4 id="_read_ftp_keyword_pass">pass |
---|
498 | |
---|
499 | |
---|
500 | |
---|
501 | |
---|
502 | |
---|
503 | |
---|
504 | <span class="attr">default:</span> <span class="value">test@test.com</span> |
---|
505 | |
---|
506 | </h4> |
---|
507 | |
---|
508 | <div class="comments"> |
---|
509 | Specify password to use when connecting. |
---|
510 | </div> |
---|
511 | |
---|
512 | <h4 id="_read_ftp_keyword_ptr">ptr |
---|
513 | |
---|
514 | |
---|
515 | |
---|
516 | |
---|
517 | |
---|
518 | |
---|
519 | |
---|
520 | |
---|
521 | </h4> |
---|
522 | |
---|
523 | <div class="comments"> |
---|
524 | Set this keyword to return an array of pointers |
---|
525 | even when there is only one file. |
---|
526 | </div> |
---|
527 | |
---|
528 | |
---|
529 | |
---|
530 | <h3>Examples</h3><div class="preformat"> |
---|
531 | 1) Retrieve and print the contents of ftp://ftp.rsinc.com/pub/gzip/README.GZIP: |
---|
532 | IDL> READ_FTP, 'ftp://ftp.rsinc.com/pub/gzip/README.GZIP', DATA=data |
---|
533 | IDL> help, data |
---|
534 | DATA BYTE = Array[2134] |
---|
535 | IDL> print, string(data) |
---|
536 | ------------------------------------------------------------------------------ |
---|
537 | README file: Research Systems Anonymous FTP site (ftp.rsinc.com) |
---|
538 | pub directory |
---|
539 | gzip directory |
---|
540 | ------------------------------------------------------------------------------ |
---|
541 | ... |
---|
542 | |
---|
543 | 2) Retrieve some files from podaac.jpl.nasa.gov and store the files |
---|
544 | in the current working directory: |
---|
545 | |
---|
546 | IDL> files = string(lindgen(10)+50,format='(%"MGB370.%3.3d.gz")') |
---|
547 | IDL> READ_FTP, 'podaac.jpl.nasa.gov', files, $ |
---|
548 | IDL> 'pub/sea_surface_height/topex_poseidon/mgdrb/data/MGB_370', /FILE |
---|
549 | IDL> spawn,'dir MGB*',/log_output |
---|
550 | Volume in drive C is Local Disk |
---|
551 | Volume Serial Number is 34CE-24DF |
---|
552 | |
---|
553 | Directory of C:testtest0307 |
---|
554 | |
---|
555 | 07/28/2003 11:58a 362,167 MGB370.050.gz |
---|
556 | 07/28/2003 11:58a 333,005 MGB370.051.gz |
---|
557 | 07/28/2003 11:58a 310,287 MGB370.052.gz |
---|
558 | 07/28/2003 11:58a 358,771 MGB370.053.gz |
---|
559 | 07/28/2003 11:59a 387,282 MGB370.054.gz |
---|
560 | 07/28/2003 11:59a 361,633 MGB370.055.gz |
---|
561 | 07/28/2003 11:59a 383,075 MGB370.056.gz |
---|
562 | 07/28/2003 11:59a 365,844 MGB370.057.gz |
---|
563 | 07/28/2003 11:59a 383,918 MGB370.058.gz |
---|
564 | 07/28/2003 12:00p 372,712 MGB370.059.gz |
---|
565 | 10 File(s) 3,618,694 bytes |
---|
566 | |
---|
567 | These compressed files can consequently be opened with OPENR and the |
---|
568 | /COMPRESSED keyword. |
---|
569 | </div> |
---|
570 | <h3>Version history</h3> |
---|
571 | |
---|
572 | <h4>Version</h4><div class="preformat"> |
---|
573 | $Id: read_ftp.pro 371 2008-08-07 09:32:02Z pinsard $ |
---|
574 | </div> |
---|
575 | <h4>History</h4><div class="preformat"> |
---|
576 | </div> |
---|
577 | |
---|
578 | |
---|
579 | <h3>Known issues</h3> |
---|
580 | |
---|
581 | |
---|
582 | <h4>Todo items</h4><div class="preformat"> |
---|
583 | seb: que fait-on de "syntax" au debut du header? |
---|
584 | give examples with date in year 0 (should not exists but may happen) |
---|
585 | </div> |
---|
586 | |
---|
587 | |
---|
588 | |
---|
589 | |
---|
590 | |
---|
591 | |
---|
592 | |
---|
593 | |
---|
594 | |
---|
595 | |
---|
596 | <h3>Statistics</h3> |
---|
597 | <table class="statistics"> |
---|
598 | <tr><td>McCabe cyclic</td><td> 19</td></tr> |
---|
599 | <tr><td>McCabe essential</td><td> 1</td></tr> |
---|
600 | <tr><td>McCabe modular design</td><td> 1</td></tr> |
---|
601 | </table> |
---|
602 | |
---|
603 | |
---|
604 | </div> |
---|
605 | |
---|
606 | </div> |
---|
607 | |
---|
608 | |
---|
609 | |
---|
610 | <div id="tagline">Produced by IDLdoc 2.0.</div> |
---|
611 | |
---|
612 | </div> |
---|
613 | |
---|
614 | </body> |
---|
615 | </html> |
---|