- Timestamp:
- 07/21/06 14:47:49 (18 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/SRC/Documentation/idldoc_html_output/ToBeReviewed/LECTURE/read_ftp.html
r138 r142 711 711 712 712 <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> 713 <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>713 <dd></dd> 714 714 715 715 <dt><p><a href="#_ftp_parse_pasv">ftp_parse_pasv<span class="result">, text, host, port</span></a></p><dt> … … 717 717 718 718 <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> 719 <dd> </dd>719 <dd> Syntax: READ_FTP, remote_host [, files] [, directory] [,/FILE] [,DATA=variable] [,USER=string] [,PASS=string] [,/PTR] </dd> 720 720 721 721 </dl> … … 733 733 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> 734 734 735 <div class="comments"></div> 736 737 738 739 740 <h3>Parameters</h3> 741 742 743 <h4 id="_ftp_post_param_u">u 744 745 746 747 748 749 750 751 752 </h4> 753 754 <div class="comments"></div> 755 756 <h4 id="_ftp_post_param_cmd">cmd 757 758 759 760 761 762 763 764 765 </h4> 766 767 <div class="comments"></div> 768 769 <h4 id="_ftp_post_param_res">res 770 771 772 773 774 775 776 777 778 </h4> 779 780 <div class="comments"></div> 781 782 783 784 785 786 787 <h3>Keywords</h3> 788 789 <h4 id="_ftp_post_keyword_out">out 790 791 792 793 794 795 796 797 798 </h4> 799 800 <div class="comments"></div> 801 802 <h4 id="_ftp_post_keyword_count">count 803 804 805 806 807 808 809 810 811 </h4> 812 813 <div class="comments"></div> 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 </div> 841 842 843 <div class="routine_details" id="_ftp_parse_pasv"> 844 845 <h2><a class="top" href="#container">top</a>ftp_parse_pasv </h2> 846 847 <p class="header"> 848 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> 849 850 <div class="comments"></div> 851 852 853 854 855 <h3>Parameters</h3> 856 857 858 <h4 id="_ftp_parse_pasv_param_text">text 859 860 861 862 863 864 865 866 867 </h4> 868 869 <div class="comments"></div> 870 871 <h4 id="_ftp_parse_pasv_param_host">host 872 873 874 875 876 877 878 879 880 </h4> 881 882 <div class="comments"></div> 883 884 <h4 id="_ftp_parse_pasv_param_port">port 885 886 887 888 889 890 891 892 893 </h4> 894 895 <div class="comments"></div> 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 </div> 926 927 928 <div class="routine_details" id="_read_ftp"> 929 930 <h2><a class="top" href="#container">top</a>read_ftp </h2> 931 932 <p class="header"> 933 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> 934 735 935 <div class="comments"> 736 READ_FTP737 936 738 937 Syntax: 739 938 READ_FTP, remote_host [, files] [, directory] [,/FILE] [,DATA=variable] 740 939 [,USER=string] [,PASS=string] [,/PTR] 741 742 Arguments 743 remote_host - Name of the remote host (ftp server) that you want 744 to connect to, or a complete ftp location such as for example: 745 ftp://ftp.rsinc.com/pub/gzip/README.GZIP 746 747 directory - Remote directory where the files reside on the ftp 748 server 749 750 files - A single filename or an array of filenames to be 751 retrieved. 752 753 Keywords 754 FILE - Set this keyword to make a local copy of the file to be 755 transferred. The local file will have the same name as the 756 remote file and will be placed in the current working 757 directory. 758 759 DATA - Set this to a named variable that will contain either a 760 byte array or an array of pointers to byte arrays with the 761 transferred data. If there is more than one file, an array 762 of pointers is returned, one for each file. 763 Note that when downloading large files using /FILE 764 instead will require much less memory since the entire file 765 is not stored in a variable in that case. 766 767 PTR - Set this keyword to return an array of pointers 768 even when there is only one file. 769 770 USER - Specify user name to connect to server with. Default is: 771 anonymous. 772 773 PASS - Specify password to use when connecting. Default is:</div> 940 </div> 774 941 775 942 … … 779 946 780 947 781 <h4 id="_ ftp_post_param_u">u 948 <h4 id="_read_ftp_param_site">site 782 949 783 950 … … 792 959 <div class="comments"></div> 793 960 794 <h4 id="_ftp_post_param_cmd">cmd 961 <h4 id="_read_ftp_param_files">files 962 963 964 965 966 967 968 969 970 </h4> 971 972 <div class="comments"> 973 A single filename or an array of filenames to be retrieved. 974 </div> 975 976 <h4 id="_read_ftp_param_dir">dir 977 978 979 980 981 982 983 984 985 </h4> 986 987 <div class="comments"> 988 Remote directory where the files reside on the ftp server 989 </div> 990 991 <h4 id="_read_ftp_param_port">port 795 992 796 993 … … 805 1002 <div class="comments"></div> 806 1003 807 <h4 id="_ftp_post_param_res">res 808 809 810 811 812 813 814 815 816 </h4>817 818 <div class="comments"></div>819 820 1004 821 1005 … … 825 1009 <h3>Keywords</h3> 826 1010 827 <h4 id="_ ftp_post_keyword_out">out 1011 <h4 id="_read_ftp_keyword_data">data 828 1012 829 1013 … … 836 1020 </h4> 837 1021 1022 <div class="comments"> 1023 Set this to a named variable that will contain either a 1024 byte array or an array of pointers to byte arrays with the 1025 transferred data. If there is more than one file, an array 1026 of pointers is returned, one for each file. 1027 Note that when downloading large files using /FILE 1028 instead will require much less memory since the entire file 1029 is not stored in a variable in that case. 1030 </div> 1031 1032 <h4 id="_read_ftp_keyword_file">file 1033 1034 1035 1036 1037 1038 1039 1040 1041 </h4> 1042 1043 <div class="comments"> 1044 Set this keyword to make a local copy of the file to be 1045 transferred. The local file will have the same name as the 1046 remote file and will be placed in the current working 1047 directory. 1048 </div> 1049 1050 <h4 id="_read_ftp_keyword_user">user 1051 1052 1053 1054 1055 1056 1057 1058 1059 </h4> 1060 1061 <div class="comments"> 1062 Specify user name to connect to server with. Default is: anonymous. 1063 </div> 1064 1065 <h4 id="_read_ftp_keyword_pass">pass 1066 1067 1068 1069 1070 1071 1072 1073 1074 </h4> 1075 838 1076 <div class="comments"></div> 839 1077 840 <h4 id="_ ftp_post_keyword_count">count 1078 <h4 id="_read_ftp_keyword_ptr">ptr 841 1079 842 1080 … … 849 1087 </h4> 850 1088 851 <div class="comments"></div> 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 </div> 879 880 881 <div class="routine_details" id="_ftp_parse_pasv"> 882 883 <h2><a class="top" href="#container">top</a>ftp_parse_pasv </h2> 884 885 <p class="header"> 886 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> 887 888 <div class="comments"></div> 889 890 891 892 893 <h3>Parameters</h3> 894 895 896 <h4 id="_ftp_parse_pasv_param_text">text 897 898 899 900 901 902 903 904 905 </h4> 906 907 <div class="comments"></div> 908 909 <h4 id="_ftp_parse_pasv_param_host">host 910 911 912 913 914 915 916 917 918 </h4> 919 920 <div class="comments"></div> 921 922 <h4 id="_ftp_parse_pasv_param_port">port 923 924 925 926 927 928 929 930 931 </h4> 932 933 <div class="comments"></div> 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 </div> 964 965 966 <div class="routine_details" id="_read_ftp"> 967 968 <h2><a class="top" href="#container">top</a>read_ftp </h2> 969 970 <p class="header"> 971 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> 972 973 <div class="comments"></div> 974 975 976 977 978 <h3>Parameters</h3> 979 980 981 <h4 id="_read_ftp_param_site">site 982 983 984 985 986 987 988 989 990 </h4> 991 992 <div class="comments"></div> 993 994 <h4 id="_read_ftp_param_files">files 995 996 997 998 999 1000 1001 1002 1003 </h4> 1004 1005 <div class="comments"></div> 1006 1007 <h4 id="_read_ftp_param_dir">dir 1008 1009 1010 1011 1012 1013 1014 1015 1016 </h4> 1017 1018 <div class="comments"></div> 1019 1020 <h4 id="_read_ftp_param_port">port 1021 1022 1023 1024 1025 1026 1027 1028 1029 </h4> 1030 1031 <div class="comments"></div> 1032 1033 1034 1035 1036 1037 1038 <h3>Keywords</h3> 1039 1040 <h4 id="_read_ftp_keyword_data">data 1041 1042 1043 1044 1045 1046 1047 1048 1049 </h4> 1050 1051 <div class="comments"></div> 1052 1053 <h4 id="_read_ftp_keyword_file">file 1054 1055 1056 1057 1058 1059 1060 1061 1062 </h4> 1063 1064 <div class="comments"></div> 1065 1066 <h4 id="_read_ftp_keyword_user">user 1067 1068 1069 1070 1071 1072 1073 1074 1075 </h4> 1076 1077 <div class="comments"></div> 1078 1079 <h4 id="_read_ftp_keyword_pass">pass 1080 1081 1082 1083 1084 1085 1086 1087 1088 </h4> 1089 1090 <div class="comments"></div> 1091 1092 <h4 id="_read_ftp_keyword_ptr">ptr 1093 1094 1095 1096 1097 1098 1099 1100 1101 </h4> 1102 1103 <div class="comments"></div> 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1089 <div class="comments"> 1090 Set this keyword to return an array of pointers 1091 even when there is only one file. 1092 </div> 1093 1094 1095 1096 <h3>Examples</h3><div class="preformat"> 1097 1) Retrieve and print the contents of ftp://ftp.rsinc.com/pub/gzip/README.GZIP: 1098 IDL> READ_FTP, 'ftp://ftp.rsinc.com/pub/gzip/README.GZIP', DATA=data 1099 IDL> help, data 1100 DATA BYTE = Array[2134] 1101 IDL> print, string(data) 1102 ------------------------------------------------------------------------------ 1103 README file: Research Systems Anonymous FTP site (ftp.rsinc.com) 1104 pub directory 1105 gzip directory 1106 ------------------------------------------------------------------------------ 1107 ... 1108 1109 2) Retrieve some files from podaac.jpl.nasa.gov and store the files 1110 in the current working directory: 1111 1112 IDL> files = string(lindgen(10)+50,format='(%"MGB370.%3.3d.gz")') 1113 IDL> READ_FTP, 'podaac.jpl.nasa.gov', files, $ 1114 IDL> 'pub/sea_surface_height/topex_poseidon/mgdrb/data/MGB_370', /FILE 1115 IDL> spawn,'dir MGB*',/log_output 1116 Volume in drive C is Local Disk 1117 Volume Serial Number is 34CE-24DF 1118 1119 Directory of C:testtest0307 1120 1121 07/28/2003 11:58a 362,167 MGB370.050.gz 1122 07/28/2003 11:58a 333,005 MGB370.051.gz 1123 07/28/2003 11:58a 310,287 MGB370.052.gz 1124 07/28/2003 11:58a 358,771 MGB370.053.gz 1125 07/28/2003 11:59a 387,282 MGB370.054.gz 1126 07/28/2003 11:59a 361,633 MGB370.055.gz 1127 07/28/2003 11:59a 383,075 MGB370.056.gz 1128 07/28/2003 11:59a 365,844 MGB370.057.gz 1129 07/28/2003 11:59a 383,918 MGB370.058.gz 1130 07/28/2003 12:00p 372,712 MGB370.059.gz 1131 10 File(s) 3,618,694 bytes 1132 1133 These compressed files can cosequently be opened with OPENR and the 1134 /COMPRESSED keyword. 1135 </div> 1136 <h3>Version history</h3> 1137 1138 <h4>Version</h4><div class="preformat"> 1139 $Id$ 1140 </div> 1141 <h4>History</h4><div class="preformat"> 1142 </div> 1143 1144 1145 <h3>Known issues</h3> 1146 1147 1148 <h4>Todo items</h4><div class="preformat"> seb: que fait-on de "syntax" au debut du header? 1149 </div> 1118 1150 1119 1151
Note: See TracChangeset
for help on using the changeset viewer.
