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

Last change on this file since 107 was 107, checked in by smasson, 18 years ago

bugfix in ead/write_oasis

File size: 10.4 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?format=raw" title="Overview of library">Overview</a></td>
36     
37
38     
39      <td >Directory</td>
40     
41
42     
43      <td><a href="./../../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td>
44     
45
46     
47      <td><a href="./../../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td>
48     
49
50     
51      <td><a href="./../../search-page.html?format=raw" title="Search library">Search</a></td>
52     
53
54      <td id="selected">File</td>
55
56     
57      <td >Source</td>
58     
59
60     
61      <td><a href="./../../idldoc-help.html?format=raw" 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?format=raw" target="_TOP">view single page</a> | <a href="./../../index.html?format=raw" 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?format=raw">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"></div>
90
91     
92
93     
94
95     
96
97     
98      <div id="routine_summary">               
99        <h2>Routine summary</h2>
100       
101        <dl>
102         
103          <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>
104          <dd>  READ_FTP   Syntax:    READ_FTP, remote_host [, files] [, directory] [,/FILE] [,DATA=variable]               [,USER=string] [,PASS=string] [,/PTR]   Arguments    remote_host - Name of the remote host (ftp server) that you want                  to connect to, or a complete ftp location such as for example:                       ftp://ftp.</dd> 
105         
106          <dt><p><a href="#_ftp_parse_pasv">ftp_parse_pasv<span class="result">, text, host, port</span></a></p><dt>
107          <dd></dd>     
108         
109          <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>
110          <dd></dd>     
111               
112        </dl>
113      </div>
114     
115
116      <div id="routine_details">
117       
118
119        <div class="routine_details" id="_ftp_post">
120
121          <h2><a class="top" href="#container">top</a>ftp_post </h2>
122       
123          <p class="header">
124            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>
125       
126          <div class="comments">
127 READ_FTP
128
129 Syntax:
130   READ_FTP, remote_host [, files] [, directory] [,/FILE] [,DATA=variable]
131              [,USER=string] [,PASS=string] [,/PTR]
132
133 Arguments
134   remote_host - Name of the remote host (ftp server) that you want
135                 to connect to, or a complete ftp location such as for example:
136                      ftp://ftp.rsinc.com/pub/gzip/README.GZIP
137
138   directory - Remote directory where the files reside on the ftp
139               server
140
141   files - A single filename or an array of filenames to be
142           retrieved.
143
144 Keywords
145   FILE - Set this keyword to make a local copy of the file to be
146          transferred.  The local file will have the same name as the
147          remote file and will be placed in the current working
148          directory.
149
150   DATA - Set this to a named variable that will contain either a
151          byte array or an array of pointers to byte arrays with the
152          transferred data.  If there is more than one file, an array
153          of pointers is returned, one for each file.
154          Note that when downloading large files using /FILE
155          instead will require much less memory since the entire file
156          is not stored in a variable in that case.
157
158   PTR  - Set this keyword to return an array of pointers
159          even when there is only one file.
160
161   USER - Specify user name to connect to server with.  Default is:
162          anonymous.
163
164   PASS - Specify password to use when connecting.  Default is:</div>
165
166         
167
168         
169            <h3>Parameters</h3>
170       
171           
172            <h4 id="_ftp_post_param_u">u&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
173             
174             
175             
176             
177             
178             
179             
180             
181            </h4>
182       
183          <div class="comments"></div>
184           
185            <h4 id="_ftp_post_param_cmd">cmd&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
186             
187             
188             
189             
190             
191             
192             
193             
194            </h4>
195       
196          <div class="comments"></div>
197           
198            <h4 id="_ftp_post_param_res">res&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
199             
200             
201             
202             
203             
204             
205             
206             
207            </h4>
208       
209          <div class="comments"></div>
210           
211
212         
213
214         
215
216            <h3>Keywords</h3>
217           
218            <h4 id="_ftp_post_keyword_out">out&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
219             
220             
221             
222             
223             
224             
225             
226             
227            </h4>
228       
229            <div class="comments"></div>
230           
231            <h4 id="_ftp_post_keyword_count">count&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
232             
233             
234             
235             
236             
237             
238             
239             
240            </h4>
241       
242            <div class="comments"></div>
243           
244         
245
246         
247         
248         
249         
250         
251         
252         
253         
254         
255         
256         
257         
258       
259         
260         
261         
262         
263         
264         
265         
266       
267         
268       
269        </div>
270       
271
272        <div class="routine_details" id="_ftp_parse_pasv">
273
274          <h2><a class="top" href="#container">top</a>ftp_parse_pasv </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"></div>
299           
300            <h4 id="_ftp_parse_pasv_param_host">host&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
301             
302             
303             
304             
305             
306             
307             
308             
309            </h4>
310       
311          <div class="comments"></div>
312           
313            <h4 id="_ftp_parse_pasv_param_port">port&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
314             
315             
316             
317             
318             
319             
320             
321             
322            </h4>
323       
324          <div class="comments"></div>
325           
326
327         
328
329         
330
331         
332         
333         
334         
335         
336         
337         
338         
339         
340         
341         
342         
343       
344         
345         
346         
347         
348         
349         
350         
351       
352         
353       
354        </div>
355       
356
357        <div class="routine_details" id="_read_ftp">
358
359          <h2><a class="top" href="#container">top</a>read_ftp </h2>
360       
361          <p class="header">
362            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>
363       
364          <div class="comments"></div>
365
366         
367
368         
369            <h3>Parameters</h3>
370       
371           
372            <h4 id="_read_ftp_param_site">site&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
373             
374             
375             
376             
377             
378             
379             
380             
381            </h4>
382       
383          <div class="comments"></div>
384           
385            <h4 id="_read_ftp_param_files">files&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
386             
387             
388             
389             
390             
391             
392             
393             
394            </h4>
395       
396          <div class="comments"></div>
397           
398            <h4 id="_read_ftp_param_dir">dir&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
399             
400             
401             
402             
403             
404             
405             
406             
407            </h4>
408       
409          <div class="comments"></div>
410           
411            <h4 id="_read_ftp_param_port">port&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
412             
413             
414             
415             
416             
417             
418             
419             
420            </h4>
421       
422          <div class="comments"></div>
423           
424
425         
426
427         
428
429            <h3>Keywords</h3>
430           
431            <h4 id="_read_ftp_keyword_data">data&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
432             
433             
434             
435             
436             
437             
438             
439             
440            </h4>
441       
442            <div class="comments"></div>
443           
444            <h4 id="_read_ftp_keyword_file">file&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
445             
446             
447             
448             
449             
450             
451             
452             
453            </h4>
454       
455            <div class="comments"></div>
456           
457            <h4 id="_read_ftp_keyword_user">user&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
458             
459             
460             
461             
462             
463             
464             
465             
466            </h4>
467       
468            <div class="comments"></div>
469           
470            <h4 id="_read_ftp_keyword_pass">pass&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
471             
472             
473             
474             
475             
476             
477             
478             
479            </h4>
480       
481            <div class="comments"></div>
482           
483            <h4 id="_read_ftp_keyword_ptr">ptr&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;
484             
485             
486             
487             
488             
489             
490             
491             
492            </h4>
493       
494            <div class="comments"></div>
495           
496         
497
498         
499         
500         
501         
502         
503         
504         
505         
506         
507         
508         
509         
510       
511         
512         
513         
514         
515         
516         
517         
518       
519         
520       
521        </div>
522       
523      </div>
524
525     
526
527      <div id="tagline">Produced by IDLdoc 2.0.</div>
528
529    </div>
530
531  </body>
532</html>
Note: See TracBrowser for help on using the repository browser.