Context Navigation

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

Last change on this file since 163 was 163, checked in by navarro, 18 years ago
header improvements : type of parameters and keywords, default values, spell checking + idldoc assistant (IDL online_help)
File size: 23.5 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	<style type="text/css" media="all">
13
14	/* CSS for all files which appear in the "main" viewing area: overview,
15	directory overviews, warnings, index, search, pro files, source
16	code, help, and etc files. */
17
18	/* Link styles --------------------------------------------------------------- */
19
20	a { text-decoration: none; }
21
22	a:link, a:visited {
23	color: #660000;
24	border-bottom: 1px dotted #C0C0F0;
25	}
26
27	a:hover, a:focus {
28	color: #993333;
29	background: #FFFFCC;
30	border-bottom: 1px dotted #303099;
31	}
32
33
34	/* Main styles --------------------------------------------------------------- */
35	p.preformat {
36	font-family: Courier;
37	}
38
39	body {
40	margin: 0;
41	padding: 0;
42	font-size: 10pt;
43	font-family: Verdana, Helvetica, Arial, sans-serif;
44	background-color: #FFFFFF;
45	}
46
47	p {
48	margin-top: 0.5em;
49	margin-bottom: 0;
50	}
51
52	#container { margin: 1em; }
53
54	code.section { white-space: pre; }
55
56	pre.snippet {
57	margin-left: 5%;
58	background: #F0F0F0;
59	border: 1px dashed #999999;
60	width: 43em;
61	padding: 0.5em 0.5em 0.5em 0.5em;
62	white-space: pre;
63	}
64
65	/* Navbar styles ------------------------------------------------------------- */
66
67	#navbar_title {
68	color: #000033;
69	background-color: #F0F0FF;
70	font-family: Arial, Helvetica, sans-serif;
71	padding: 20px 30px;
72	border-bottom: 1px solid #000033;
73	}
74
75	#navbar_title * {
76	margin: 0;
77	padding: 0;
78	}
79
80	#navbar_title h1 {
81	letter-spacing: 0.1em;
82	font-variant: small-caps;
83	font-size: 250%;
84	text-indent: -1em;
85	padding-left: 1em;
86	}
87
88	#navbar_title h2 {
89	font-size: 110%;
90	font-weight: normal;
91	color: #333399;
92	}
93
94	#main_navbar table {
95	width: 100%;
96	border-bottom: 1px solid #666699;
97	}
98
99	#main_navbar td {
100	background: #CCCCFF;
101	font-size: 80%;
102	font-weight: bold;
103	font-family: Arial, Helvetica, sans-serif;
104	border-top: 3px solid #CCCCFF;
105	border-bottom: 3px solid #CCCCFF;
106	padding-left: 6px;
107	padding-right: 6px;
108	margin: 0;
109	}
110
111	#main_navbar td#selected {
112	background: #CCCCFF;
113	font-size: 80%;
114	font-weight: bold;
115	font-family: Arial, Helvetica, sans-serif;
116	border-top: 3px solid #333399;
117	border-bottom: 3px solid #CCCCFF;
118	padding-left: 6px;
119	padding-right: 6px;
120	margin: 0;
121	}
122
123	#main_navbar td#flexible {
124	width: 100%;
125	text-align: right;
126	padding-right: 1em;
127	background: #CCCCFF;
128	font-size: 70%;
129	font-weight: normal;
130	font-family: Arial, Helvetica, sans-serif;
131	text-transform: uppercase;
132	border-top: 3px solid #CCCCFF;
133	border-bottom: 3px solid #CCCCFF;
134	}
135
136	#main_navbar a:link, #main_navbar a:visited { color: #660000; border: 0; }
137
138	#main_navbar a:hover, #main_navbar a:focus {
139	color: #FFFF66;
140	background: #CCCCFF;
141	border-bottom: 1px none #606099;
142	border: 0;
143	}
144
145	#secondary_navbar {
146	font-size: 80%;
147	font-weight: normal;
148	font-family: Arial, Helvetica, sans-serif;
149	margin-top: 4px;
150	margin-left: 20px;
151	white-space: nowrap;
152	}
153
154
155	/* Tagline and footer styles ------------------------------------------------- */
156
157	div#tagline {
158	margin-top: 6px;
159	border-top: 1px dotted lightsteelblue;
160	padding-top: 6px;
161	font-size: 66%;
162	font-style: italic;
163	}
164
165	div#footer {
166	margin-top: 6px;
167	border-top: 1px dotted lightsteelblue;
168	padding-top: 6px;
169	font-size: 66%;
170	font-style: italic;
171	}
172
173	/* Basic data presenation styles -------------------------------------------- */
174
175	.index_letter {
176	font-size: 300%;
177	font-weight: bold;
178	color: #000066;
179	margin: 0.5em 0 0 -0.1em;
180	}
181
182	h1, h2, h3, h4 {
183	font-weight: normal;
184	color: #3333CC;
185	}
186
187	h1 {
188	padding-top: 0.75em;
189	font-size: 160%;
190	}
191
192	h2 {
193	padding-top: 1em;
194	font-size: 120%;
195	}
196
197	h3 {
198	padding-top: 0.75em;
199	margin-bottom: 0.25em;
200	font-size: 100%;
201	}
202
203	h4 {
204	padding: 0;
205	margin: 0.5em 0 0 0;
206	font-size: 80%;
207	}
208
209	table.basic {
210	empty-cells: show;
211	margin: 1.5em 1em 0 1em;
212	border: 1px dotted #CFCFFF;
213	font-size: 80%;
214	}
215
216	table.basic th {
217	background-color: #F0F0FF;
218	font-weight: bold;
219	text-align: left;
220	padding: 4px 1em 4px 4px;
221	border-bottom: 1px dotted #666699;
222	}
223
224	table.basic td {
225	vertical-align: top;
226	padding: 4px 1em 4px 4px;
227	}
228
229	dd {
230	margin-bottom: 0.25em;
231	font-size: 80%;
232	}
233
234
235	/* Warnings styles ----------------------------------------------------------- */
236
237
238	#todo dl, #bugs dl {
239	margin: 0 0 0 1.5em;
240	font-size: 80%;
241	}
242
243	#todo dd, #bugs dd {
244	margin-left: 3em;
245	font-size: 100%;
246	}
247
248	#undoc table, #obsolete table, #statistics table {
249	width: 80%;
250	margin-left: 2em;
251	}
252
253	#undoc td, #obsolete td, #statistics td {
254	padding: 0 0 0 0;
255	font-size: 80%;
256	white-space: nowrap;
257	}
258
259	#undoc td.docroutine, #obsolete td.obsroutine, #statistics td.statroutine { width: 50%; }
260
261	#undoc td.docstat, #statistics td.stat {
262	width: 50%;
263	text-align: right;
264	}
265
266	#undoc td.partialdoc, #statistics td.caution { color: #CC6600; }
267
268	#undoc td.notdoc, #statistics td.warning { color: #993333; }
269
270	/* File + routine styles ----------------------------------------------------- */
271
272	h1.directory {
273	padding: 1em 0 0 0;
274	margin: 0;
275	font-size: 66%;
276	}
277
278	h1.directory a { border-bottom: 0; }
279
280	h2.pro_file {
281	padding: 0;
282	margin: 0;
283	font-size: 140%;
284	}
285
286	div#file_attr {
287	padding: 0 1em 0 1em;
288	margin: 1em;
289	background: #F6F6F6;
290	border: 1px dotted #999999;
291	}
292
293	div#file_attr dt {
294	font-size: 80%;
295	font-weight: bold;
296	}
297
298	div#file_attr dd {
299	font-size: 80%;
300	}
301
302	div#class_diagram {
303	padding: 1em 0 1em 0;
304	white-space: pre;
305	font-family: 'Courier New';
306	}
307
308	table#sav_attr {
309	font-size: 90%;
310	margin: 1em;
311	padding: 1em 1em 1em 1em;
312	background: #F6F6F6;
313	border: 1px dotted #999999;
314	}
315
316	table#sav_attr th { text-align: left; }
317
318	table#sav_attr td { vertical-align: top; padding-right: 2em; }
319
320	table#sav_attr td.value { width: 20em; padding-right: 0em; font-style: italic; }
321
322	p.sav_warning { margin-left: 4em; font-family: 80%; }
323
324	table.variables {
325	font-family: 'Courier New', monospace;
326	font-size: 80%;
327	text-indent: -2em;
328	padding-left: 2em;
329	}
330
331	table.variables td.image { width: 64px; }
332
333	div#file_comments { white-space: pre;
334	margin: 2em;
335	font-size: 80%;
336	}
337
338
339	div.field_summary {
340	padding: 0 1em 0 1em;
341	margin: 1em;
342	background: #FFFFF0;
343	border: 1px dotted #C0C000;
344	}
345
346	div#routine_summary {
347	padding: 0 1em 0 1em;
348	margin: 1em;
349	background: #F0F0FF;
350	border: 1px dotted #9999FF;
351	}
352
353	div.field_summary h2, div#routine_summary h2 {
354	padding: 0.5em 0 0 0;
355	margin: 0;
356	}
357
358	div.field_summary table, div.field_summary p {
359	margin: 1em 1em;
360	}
361
362	div.field_summary td.name {
363	vertical-align: top;
364	padding-bottom: 0.25em;
365	color: #3333CC;
366	}
367
368	div.field_summary span.field_type {
369	font-weight: normal;
370	font-size: 80%;
371	color: black;
372	}
373
374	div.field_summary td.comments {
375	vertical-align: top;
376	padding-left: 2em;
377	font-size: 80%;
378	}
379
380	p.commaList {
381	margin: 1em 1em 1em 1em;
382	}
383
384	span.warning {
385	color: #CC6633;
386	font-weight: bold;
387	font-size: 66%;
388	text-transform: uppercase;
389	}
390
391	span.categories {
392	color: #006633;
393	font-weight: bold;
394	font-size: 66%;
395	text-transform: uppercase;
396	}
397
398	span.undoc {
399	color: #FF6633;
400	font-weight: bold;
401	font-size: 80%;
402	text-transform: uppercase;
403	}
404
405	span.attr {
406	color: #006633;
407	font-weight: bold;
408	font-size: 80%;
409	text-transform: uppercase;
410	}
411
412	span.value {
413	color: #006633;
414	font-weight: normal;
415	text-transform: none;
416	}
417
418	a.top {
419	font-weight: bold;
420	font-size: 66%;
421	text-transform: uppercase;
422	float: right;
423	}
424
425	span.result {
426	font-family: Verdana, Arial, Helvetica, sans-serif;
427	font-style: italic;
428	font-size: 80%;
429	}
430
431	div#routine_summary p, div.routine_details p.header {
432	padding-top: 0.5em;
433	margin-left: 1.5em;
434	text-indent: -1.5em;
435	font-family: 'Courier New', monospace;
436	}
437
438	div.routine_details {
439	padding: 0.5em 1em 0.5em 1em;
440	margin: 1em;
441	border: 1px dotted #CCCCCC;
442	}
443
444	div.routine_details h2 {
445	padding-top: 0;
446	margin-top: 0;
447	}
448
449	div.routine_details div.value {
450	margin: 0 1em 0 1em;
451	font-size: 80%;
452	}
453
454	div.routine_details div.comments {
455	font-size: 80%;
456	margin: 0.75em 1em 1em 1em;
457	}
458
459	div.routine_details div.preformat {
460	white-space: pre;
461	}
462
463	table.statistics {
464	font-size: 80%;
465	margin-left: 1em;
466	}
467
468	table.statistics td {
469	padding: 0 2em 0 0;
470	}
471
472	/* Overview styles ----------------------------------------------------------- */
473
474	div.overview {
475	width: 100%;
476	margin-top: 1em;
477	clear: both;
478	}
479
480	div.overview table {
481	empty-cells: show;
482	font-size: 90%;
483	margin: 1em 1em 1em 1em;
484	padding: 1em 0.5em 1em 0.5em;
485	background: #F6F6F6;
486	border: 1px dotted #999999;
487	}
488
489	div.overview td {
490	padding: 3px 1em 3px 1em;
491	}
492
493	div.overview td.dir {
494	width: 1%;
495	vertical-align: top;
496	text-align: right;
497	padding-right: 1em;
498	}
499
500
501	/* Navigation list styles for tree structures -------------------------------- */
502
503	#tree {
504	text-align: left;
505	font-size: 90%;
506	margin: 0.75em 0 0.75em 0;
507	padding: 0;
508	}
509
510	#tree ul {
511	text-align: left;
512	margin: 0;
513	padding: 0;
514	}
515
516	#tree li {
517	margin: 0 0 0 15px;
518	padding: 0;
519	list-style-type: none;
520	}
521
522	#tree .symbols {
523	float: left;
524	width: 12px;
525	height: 1em;
526	padding-left: 4px;
527	background-position: 0 100%;
528	background-repeat: no-repeat;
529	}
530
531	/* Search styles ------------------------------------------------------------- */
532
533	input.writein {
534	padding-left: 0.5em;
535	border: 1px solid #CCCCCC;
536	font-family: 'Courier New';
537	background: #FFFFF3;
538	}
539
540	#search form {
541	margin-left: 2em;
542	}
543
544	#search table {
545	margin: 1em 1em 0 2em;
546	padding: 1em 2em 1em 2em;
547	background: #F6F6F6;
548	border: 1px dotted #999999;
549	}
550
551	#search tr {
552	text-align: center;
553	}
554
555	#search td {
556	font-size: 80%;
557	text-align: left;
558	}
559
560	#search td * {
561	vertical-align: middle;
562	}
563
564	#search p {
565	font-size: 66%;
566	margin: 0 3em 2em 3em;
567	}
568
569	/* Help styles --------------------------------------------------------------- */
570
571	div.toc {
572	padding: 0 1em 0 1em;
573	margin: 1em;
574	background: #F0F0FF;
575	border: 1px dotted #9999FF;
576	width: 19em;
577	}
578
579	div.right {
580	float: right;
581	width: 22em;
582	}
583
584	ol.toc {
585	list-style-type: upper-roman;
586	}
587
588	ol.toc ol {
589	padding-left: 3em;
590	margin-left: 0;
591	list-style-type: lower-alpha;
592	}
593
594	dl.variables dt { font-size: 80%; }
595	dl.variables dd { margin-bottom: 0.5em; }
596
597	</style>
598	<style type="text/css" media="print">
599	#navbar_title {
600	background-color: #FFFFFF;
601	}
602
603	#main_navbar td {
604	background: #FFFFFF;
605	border-top: 0.25em solid #FFFFFF;
606	border-bottom: 0.25em solid #FFFFFF;
607	}
608
609	#main_navbar td#selected {
610	background: #FFFFFF;
611	border-top: 0.25em solid #333399;
612	border-bottom: 0.25em solid #FFFFFF;
613	}
614
615	#main_navbar td#flexible {
616	background: #FFFFFF;
617	border-top: 0.25em solid #FFFFFF;
618	border-bottom: 0.25em solid #FFFFFF;
619	}
620
621	#secondary_navbar {
622	display: none;
623	}
624
625	</style>
626
627
628	<script type="text/javascript">
629	function setTitle() {
630	parent.document.title="read_ftp.pro (SAXO Documentation)";
631	}
632	</script>
633	</head>
634
635	<body onload="setTitle();">
636
637	<div id="navbar_title">
638	<h1>SAXO Documentation</h1>
639	</div>
640
641
642	<div id="main_navbar">
643
644	<table cellspacing="0">
645	<tr>
646
647	<td><a href="./../../overview.html?format=raw" title="Overview of library">Overview</a></td>
648
649
650
651	<td >Directory</td>
652
653
654
655	<td><a href="./../../idldoc-categories.html?format=raw" title="Browse library by category">Categories</a></td>
656
657
658
659	<td><a href="./../../idldoc-index.html?format=raw" title="Index of files, routines, and parameters">Index</a></td>
660
661
662
663	<td><a href="./../../search-page.html?format=raw" title="Search library">Search</a></td>
664
665
666	<td id="selected">File</td>
667
668
669	<td >Source</td>
670
671
672
673	<td><a href="./../../idldoc-help.html?format=raw" title="Help on IDLdoc">Help</a></td>
674
675
676	<td >Etc</td>
677
678	<td id="flexible">Developer documentation</td>
679	</tr>
680	</table>
681
682	</div>
683
684	<div id="secondary_navbar">
685
686	<a href="ncdf_lec.html?format=raw"><<prev file</a> \| <a href="read_ncdf.html?format=raw">next file >></a>    <a href="read_ftp.html?format=raw" target="_TOP">view single page</a> \| <a href="./../../index.html?format=raw" target="_TOP">view frames</a>    summary: fields \| <a href="#routine_summary">routine</a>    details: <a href="#routine_details">routine</a>
687
688	</div>
689
690
691	<div id="container">
692
693	<h1 class="directory"><a href="directory-overview.html?format=raw">ToBeReviewed/LECTURE/</a></h1>
694	<h2 class="pro_file">read_ftp.pro</h2>
695
696	<div id="file_attr">
697	<dl>
698	</dl>
699	</div>
700
701	<div id="file_comments">
702
703
704
705
706
707
708	READ_FTP, remote_host [, files] [, directory] [,/FILE] [,DATA=variable]
709	[,USER=string] [,PASS=string] [,/PTR]
710	</div>
711
712
713
714
715
716
717
718
719	<div id="routine_summary">
720	<h2>Routine summary</h2>
721
722	<dl>
723
724	<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>
725	<dd></dd>
726
727	<dt><p><a href="#_ftp_parse_pasv">ftp_parse_pasv<span class="result">, text, host, port</span></a></p><dt>
728	<dd></dd>
729
730	<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>
731	<dd> </dd>
732
733	</dl>
734	</div>
735
736
737	<div id="routine_details">
738
739
740	<div class="routine_details" id="_ftp_post">
741
742	<h2><a class="top" href="#container">top</a>ftp_post <span class="categories">
743
744	</span></h2>
745
746	<p class="header">
747	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>
748
749	<div class="comments"></div>
750
751
752
753
754	<h3>Parameters</h3>
755
756
757	<h4 id="_ftp_post_param_u">u
758
759
760
761
762
763
764
765
766	</h4>
767
768	<div class="comments">
769
770	</div>
771
772	<h4 id="_ftp_post_param_cmd">cmd
773
774
775
776
777
778
779
780
781	</h4>
782
783	<div class="comments">
784
785	</div>
786
787	<h4 id="_ftp_post_param_res">res
788
789
790
791
792
793
794
795
796	</h4>
797
798	<div class="comments">
799
800	</div>
801
802
803
804
805
806
807	<h3>Keywords</h3>
808
809	<h4 id="_ftp_post_keyword_out">out
810
811
812
813
814
815
816
817
818	</h4>
819
820	<div class="comments">
821
822	</div>
823
824	<h4 id="_ftp_post_keyword_count">count
825
826
827
828
829
830
831
832
833	</h4>
834
835	<div class="comments">
836	Upon return, the number of elements in the result set.
837	This is only important when the result set is the empty
838	set, in which case COUNT is set to zero.
839	</div>
840
841
842
843	<h3>Examples</h3><div class="preformat">
844
845	</div>
846	<h3>Version history</h3>
847
848	<h4>Version</h4><div class="preformat">
849	$Id: read_ftp.pro 157 2006-08-21 09:01:50Z navarro $</div>
850	<h4>History</h4><div class="preformat">
851
852	</div>
853
854
855	<h3>Known issues</h3>
856
857
858
859	<h4>Restrictions</h4><div class="preformat">
860
861	</div>
862
863
864
865
866
867
868
869
870
871	<h3>Statistics</h3>
872	<table class="statistics">
873	<tr><td>McCabe cyclic</td><td> 7</td></tr>
874	<tr><td>McCabe essential</td><td> 3</td></tr>
875	<tr><td>McCabe modular design</td><td> 1</td></tr>
876	</table>
877
878
879	</div>
880
881
882	<div class="routine_details" id="_ftp_parse_pasv">
883
884	<h2><a class="top" href="#container">top</a>ftp_parse_pasv <span class="categories">
885
886	</span></h2>
887
888	<p class="header">
889	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>
890
891	<div class="comments"></div>
892
893
894
895
896	<h3>Parameters</h3>
897
898
899	<h4 id="_ftp_parse_pasv_param_text">text
900
901
902
903
904
905
906
907
908	</h4>
909
910	<div class="comments">
911	ASCII text string containing the message.
912	</div>
913
914	<h4 id="_ftp_parse_pasv_param_host">host
915
916
917
918
919
920
921
922
923	</h4>
924
925	<div class="comments">
926
927	</div>
928
929	<h4 id="_ftp_parse_pasv_param_port">port
930
931
932
933
934
935
936
937
938	</h4>
939
940	<div class="comments">
941	</div>
942
943
944
945
946
947
948	<h3>Examples</h3><div class="preformat">
949
950	</div>
951	<h3>Version history</h3>
952
953	<h4>Version</h4><div class="preformat">
954	$Id: read_ftp.pro 157 2006-08-21 09:01:50Z navarro $</div>
955	<h4>History</h4><div class="preformat">
956
957	</div>
958
959
960	<h3>Known issues</h3>
961
962
963
964	<h4>Restrictions</h4><div class="preformat">
965
966	</div>
967
968
969
970
971
972
973
974
975
976	<h3>Statistics</h3>
977	<table class="statistics">
978	<tr><td>McCabe cyclic</td><td> 2</td></tr>
979	<tr><td>McCabe essential</td><td> 1</td></tr>
980	<tr><td>McCabe modular design</td><td> 1</td></tr>
981	</table>
982
983
984	</div>
985
986
987	<div class="routine_details" id="_read_ftp">
988
989	<h2><a class="top" href="#container">top</a>read_ftp </h2>
990
991	<p class="header">
992	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>
993
994	<div class="comments">
995	</div>
996
997
998
999
1000	<h3>Parameters</h3>
1001
1002
1003	<h4 id="_read_ftp_param_site">site
1004
1005
1006
1007
1008
1009
1010
1011
1012	</h4>
1013
1014	<div class="comments"></div>
1015
1016	<h4 id="_read_ftp_param_files">files
1017
1018
1019
1020
1021
1022
1023
1024
1025	</h4>
1026
1027	<div class="comments">
1028	A single filename or an array of filenames to be retrieved.
1029	</div>
1030
1031	<h4 id="_read_ftp_param_dir">dir
1032
1033
1034
1035
1036
1037
1038
1039
1040	</h4>
1041
1042	<div class="comments">
1043	Remote directory where the files reside on the ftp server
1044	</div>
1045
1046	<h4 id="_read_ftp_param_port">port
1047
1048
1049
1050
1051
1052
1053
1054
1055	</h4>
1056
1057	<div class="comments"></div>
1058
1059
1060
1061
1062
1063
1064	<h3>Keywords</h3>
1065
1066	<h4 id="_read_ftp_keyword_data">data
1067
1068
1069
1070
1071
1072
1073
1074
1075	</h4>
1076
1077	<div class="comments">
1078	Set this to a named variable that will contain either a
1079	byte array or an array of pointers to byte arrays with the
1080	transferred data. If there is more than one file, an array
1081	of pointers is returned, one for each file.
1082	Note that when downloading large files using /FILE
1083	instead will require much less memory since the entire file
1084	is not stored in a variable in that case.
1085	</div>
1086
1087	<h4 id="_read_ftp_keyword_file">file
1088
1089
1090
1091
1092
1093
1094
1095
1096	</h4>
1097
1098	<div class="comments">
1099	Set this keyword to make a local copy of the file to be
1100	transferred. The local file will have the same name as the
1101	remote file and will be placed in the current working
1102	directory.
1103	</div>
1104
1105	<h4 id="_read_ftp_keyword_user">user
1106
1107
1108
1109
1110
1111
1112
1113
1114	</h4>
1115
1116	<div class="comments">
1117	Specify user name to connect to server with.
1118	</div>
1119
1120	<h4 id="_read_ftp_keyword_pass">pass
1121
1122
1123
1124
1125
1126
1127
1128
1129	</h4>
1130
1131	<div class="comments">
1132	Specify password to use when connecting.
1133	</div>
1134
1135	<h4 id="_read_ftp_keyword_ptr">ptr
1136
1137
1138
1139
1140
1141
1142
1143
1144	</h4>
1145
1146	<div class="comments">
1147	Set this keyword to return an array of pointers
1148	even when there is only one file.
1149	</div>
1150
1151
1152
1153	<h3>Examples</h3><div class="preformat">
1154	1) Retrieve and print the contents of ftp://ftp.rsinc.com/pub/gzip/README.GZIP:
1155	IDL> READ_FTP, 'ftp://ftp.rsinc.com/pub/gzip/README.GZIP', DATA=data
1156	IDL> help, data
1157	DATA BYTE = Array[2134]
1158	IDL> print, string(data)
1159	------------------------------------------------------------------------------
1160	README file: Research Systems Anonymous FTP site (ftp.rsinc.com)
1161	pub directory
1162	gzip directory
1163	------------------------------------------------------------------------------
1164	...
1165
1166	2) Retrieve some files from podaac.jpl.nasa.gov and store the files
1167	in the current working directory:
1168
1169	IDL> files = string(lindgen(10)+50,format='(%"MGB370.%3.3d.gz")')
1170	IDL> READ_FTP, 'podaac.jpl.nasa.gov', files, $
1171	IDL> 'pub/sea_surface_height/topex_poseidon/mgdrb/data/MGB_370', /FILE
1172	IDL> spawn,'dir MGB*',/log_output
1173	Volume in drive C is Local Disk
1174	Volume Serial Number is 34CE-24DF
1175
1176	Directory of C:testtest0307
1177
1178	07/28/2003 11:58a 362,167 MGB370.050.gz
1179	07/28/2003 11:58a 333,005 MGB370.051.gz
1180	07/28/2003 11:58a 310,287 MGB370.052.gz
1181	07/28/2003 11:58a 358,771 MGB370.053.gz
1182	07/28/2003 11:59a 387,282 MGB370.054.gz
1183	07/28/2003 11:59a 361,633 MGB370.055.gz
1184	07/28/2003 11:59a 383,075 MGB370.056.gz
1185	07/28/2003 11:59a 365,844 MGB370.057.gz
1186	07/28/2003 11:59a 383,918 MGB370.058.gz
1187	07/28/2003 12:00p 372,712 MGB370.059.gz
1188	10 File(s) 3,618,694 bytes
1189
1190	These compressed files can cosequently be opened with OPENR and the
1191	/COMPRESSED keyword.
1192	</div>
1193	<h3>Version history</h3>
1194
1195	<h4>Version</h4><div class="preformat">
1196	$Id: read_ftp.pro 157 2006-08-21 09:01:50Z navarro $
1197	</div>
1198	<h4>History</h4><div class="preformat">
1199	</div>
1200
1201
1202	<h3>Known issues</h3>
1203
1204
1205	<h4>Todo items</h4><div class="preformat">
1206	seb: que fait-on de "syntax" au debut du header?
1207	give examples with date in year 0 (should not exists but may happen)
1208	</div>
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219	<h3>Statistics</h3>
1220	<table class="statistics">
1221	<tr><td>McCabe cyclic</td><td> 19</td></tr>
1222	<tr><td>McCabe essential</td><td> 1</td></tr>
1223	<tr><td>McCabe modular design</td><td> 1</td></tr>
1224	</table>
1225
1226
1227	</div>
1228
1229	</div>
1230
1231
1232
1233	<div id="tagline">Produced by IDLdoc 2.0.</div>
1234
1235	</div>
1236
1237	</body>
1238	</html>

Note: See TracBrowser for help on using the repository browser.

Download in other formats: