source: trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/LECTURE/read_ftp.html @ 191

Last change on this file since 191 was 191, checked in by pinsard, 18 years ago

remove format=raw in all html files 2+ : correction for all_plots; suppression of css and correction of Source links in idldoc html output

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