Context Navigation

source: trunk/SRC/Documentation/idldoc_assistant_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: 10.7 KB

Line
1
2
3	<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4	<head>
5	<title>read_ftp.pro (SAXO Documentation Assistant)</title>
6	</head>
7
8	<body text="#000000" bgcolor="#FFFFFF">
9
10
11	<!-- Navbar template takes a structure with the following fields:
12	overview_href :
13	overview_selected :
14	dir_overview_href :
15	dir_overview_selected :
16	categories_href :
17	categories_selected :
18	index_href :
19	index_selected :
20	search_href :
21	search_selected :
22	file_selected :
23	source_href :
24	source_selected :
25	help_href :
26	help_selected :
27	etc_selected :
28
29	prev_file_href :
30	next_file_href :
31
32	view_single_page_href :
33	view_frames_href :
34
35	summary_fields_href :
36	summary_routine_href :
37	details_routine_href :
38
39	title :
40	subtitle :
41	user :
42	-->
43
44
45	<table border="0" cellpadding="0" cellspacing="0" width="98%" bgcolor="#F0F0FF" valign="bottom">
46	<tr>
47	<td width="10%">
48	<a href="ncdf_lec.html"><img src="./../../prev.gif" border="0" alt="Previous"></a></td>
49	<td width="80%" align="center" valign="center">
50	<font size=-1><i>SAXO Documentation Assistant</i>: <a href="./../../home.html">Overview</a></font></td>
51	<td width="10%" align="right">
52	<a href="read_ncdf.html"><img src="./../../next.gif" border="0" alt="Next"></a></td>
53	</tr>
54	</table>
55
56
57	<h1><font size="-2">ToBeReviewed/LECTURE/</font></h1>
58	<h2>read_ftp.pro</h2>
59
60	<dl>
61	</dl>
62
63
64
65
66
67
68
69
70	READ_FTP, remote_host [, files] [, directory] [,/FILE] [,DATA=variable]
71	[,USER=string] [,PASS=string] [,/PTR]
72
73
74
75	<h2>Routine summary</h2>
76
77	<dl>
78
79	<dt><a href="#_ftp_post">ftp_post<i>, u, cmd, res</i>, out=<i>out</i>, count=<i>count</i></a><dt>
80	<dd><font size="-1"></font></dd>
81
82	<dt><a href="#_ftp_parse_pasv">ftp_parse_pasv<i>, text, host, port</i></a><dt>
83	<dd><font size="-1"></font></dd>
84
85	<dt><a href="#_read_ftp">read_ftp<i>, site, files, dir, port</i>, data=<i>data</i>, file=<i>file</i>, user=<i>user</i>, pass=<i>pass</i>, ptr=<i>ptr</i></a><dt>
86	<dd><font size="-1"> </font></dd>
87
88	</dl>
89
90	<p> </p>
91
92
93
94	<a name="#_ftp_post"></a>
95
96	<h2>ftp_post <font size="-1" color="#006633">
97
98	</font></h2>
99
100	<p><font face="Courier">ftp_post<i>, <a href="#_ftp_post_keyword_u">u</a>, <a href="#_ftp_post_keyword_cmd">cmd</a>, <a href="#_ftp_post_keyword_res">res</a></i>, <a href="#_ftp_post_keyword_out">out</a>=<i>out</i>, <a href="#_ftp_post_keyword_count">count</a>=<i>count</i></font></p>
101
102
103
104
105
106
107	<h3>Parameters</h3>
108
109
110	<a name="#_ftp_post_keyword_u"></a>
111	<h4>u
112
113
114
115
116
117
118
119
120	</h4>
121
122
123
124
125
126
127	<a name="#_ftp_post_keyword_cmd"></a>
128	<h4>cmd
129
130
131
132
133
134
135
136
137	</h4>
138
139
140
141
142
143
144	<a name="#_ftp_post_keyword_res"></a>
145	<h4>res
146
147
148
149
150
151
152
153
154	</h4>
155
156
157
158
159
160
161
162
163	<h3>Keywords</h3>
164
165
166	<a name="#_ftp_post_keyword_out"></a>
167	<h4>out
168
169
170
171
172
173
174
175
176	</h4>
177
178
179
180
181
182	<a name="#_ftp_post_keyword_count"></a>
183	<h4>count
184
185
186
187
188
189
190
191
192	</h4>
193
194
195	Upon return, the number of elements in the result set.
196	This is only important when the result set is the empty
197	set, in which case COUNT is set to zero.
198
199
200
201
202	<h3>Examples</h3>
203
204
205	<h3>Version history</h3>
206
207	<h4>Version</h4>
208	$Id: read_ftp.pro 157 2006-08-21 09:01:50Z navarro $
209	<h4>History</h4>
210
211
212
213
214	<h3>Known issues</h3>
215
216
217
218	<h4>Restrictions</h4>
219
220
221
222
223
224
225
226
227
228
229
230	<font size="-3"><p> </p></font>
231	<hr size="1" color="#CCCCCC"/>
232
233	<a name="#_ftp_parse_pasv"></a>
234
235	<h2>ftp_parse_pasv <font size="-1" color="#006633">
236
237	</font></h2>
238
239	<p><font face="Courier">ftp_parse_pasv<i>, <a href="#_ftp_parse_pasv_keyword_text">text</a>, <a href="#_ftp_parse_pasv_keyword_host">host</a>, <a href="#_ftp_parse_pasv_keyword_port">port</a></i></font></p>
240
241
242
243
244
245
246	<h3>Parameters</h3>
247
248
249	<a name="#_ftp_parse_pasv_keyword_text"></a>
250	<h4>text
251
252
253
254
255
256
257
258
259	</h4>
260
261
262	ASCII text string containing the message.
263
264
265
266	<a name="#_ftp_parse_pasv_keyword_host"></a>
267	<h4>host
268
269
270
271
272
273
274
275
276	</h4>
277
278
279
280
281
282
283	<a name="#_ftp_parse_pasv_keyword_port"></a>
284	<h4>port
285
286
287
288
289
290
291
292
293	</h4>
294
295
296
297
298
299
300
301
302	<h3>Examples</h3>
303
304
305	<h3>Version history</h3>
306
307	<h4>Version</h4>
308	$Id: read_ftp.pro 157 2006-08-21 09:01:50Z navarro $
309	<h4>History</h4>
310
311
312
313
314	<h3>Known issues</h3>
315
316
317
318	<h4>Restrictions</h4>
319
320
321
322
323
324
325
326
327
328
329
330	<font size="-3"><p> </p></font>
331	<hr size="1" color="#CCCCCC"/>
332
333	<a name="#_read_ftp"></a>
334
335	<h2>read_ftp </h2>
336
337	<p><font face="Courier">read_ftp<i>, <a href="#_read_ftp_keyword_site">site</a>, <a href="#_read_ftp_keyword_files">files</a>, <a href="#_read_ftp_keyword_dir">dir</a>, <a href="#_read_ftp_keyword_port">port</a></i>, <a href="#_read_ftp_keyword_data">data</a>=<i>data</i>, <a href="#_read_ftp_keyword_file">file</a>=<i>file</i>, <a href="#_read_ftp_keyword_user">user</a>=<i>user</i>, <a href="#_read_ftp_keyword_pass">pass</a>=<i>pass</i>, <a href="#_read_ftp_keyword_ptr">ptr</a>=<i>ptr</i></font></p>
338
339
340
341
342
343
344
345	<h3>Parameters</h3>
346
347
348	<a name="#_read_ftp_keyword_site"></a>
349	<h4>site
350
351
352
353
354
355
356
357
358	</h4>
359
360
361
362
363	<a name="#_read_ftp_keyword_files"></a>
364	<h4>files
365
366
367
368
369
370
371
372
373	</h4>
374
375
376	A single filename or an array of filenames to be retrieved.
377
378
379
380	<a name="#_read_ftp_keyword_dir"></a>
381	<h4>dir
382
383
384
385
386
387
388
389
390	</h4>
391
392
393	Remote directory where the files reside on the ftp server
394
395
396
397	<a name="#_read_ftp_keyword_port"></a>
398	<h4>port
399
400
401
402
403
404
405
406
407	</h4>
408
409
410
411
412
413
414	<h3>Keywords</h3>
415
416
417	<a name="#_read_ftp_keyword_data"></a>
418	<h4>data
419
420
421
422
423
424
425
426
427	</h4>
428
429
430	Set this to a named variable that will contain either a
431	byte array or an array of pointers to byte arrays with the
432	transferred data. If there is more than one file, an array
433	of pointers is returned, one for each file.
434	Note that when downloading large files using /FILE
435	instead will require much less memory since the entire file
436	is not stored in a variable in that case.
437
438
439	<a name="#_read_ftp_keyword_file"></a>
440	<h4>file
441
442
443
444
445
446
447
448
449	</h4>
450
451
452	Set this keyword to make a local copy of the file to be
453	transferred. The local file will have the same name as the
454	remote file and will be placed in the current working
455	directory.
456
457
458	<a name="#_read_ftp_keyword_user"></a>
459	<h4>user
460
461
462
463
464
465
466
467
468	</h4>
469
470
471	Specify user name to connect to server with.
472
473
474	<a name="#_read_ftp_keyword_pass"></a>
475	<h4>pass
476
477
478
479
480
481
482
483
484	</h4>
485
486
487	Specify password to use when connecting.
488
489
490	<a name="#_read_ftp_keyword_ptr"></a>
491	<h4>ptr
492
493
494
495
496
497
498
499
500	</h4>
501
502
503	Set this keyword to return an array of pointers
504	even when there is only one file.
505
506
507
508
509	<h3>Examples</h3>
510	1) Retrieve and print the contents of ftp://ftp.rsinc.com/pub/gzip/README.GZIP:
511	IDL> READ_FTP, 'ftp://ftp.rsinc.com/pub/gzip/README.GZIP', DATA=data
512	IDL> help, data
513	DATA BYTE = Array[2134]
514	IDL> print, string(data)
515	------------------------------------------------------------------------------
516	README file: Research Systems Anonymous FTP site (ftp.rsinc.com)
517	pub directory
518	gzip directory
519	------------------------------------------------------------------------------
520	...
521
522	2) Retrieve some files from podaac.jpl.nasa.gov and store the files
523	in the current working directory:
524
525	IDL> files = string(lindgen(10)+50,format='(%"MGB370.%3.3d.gz")')
526	IDL> READ_FTP, 'podaac.jpl.nasa.gov', files, $
527	IDL> 'pub/sea_surface_height/topex_poseidon/mgdrb/data/MGB_370', /FILE
528	IDL> spawn,'dir MGB*',/log_output
529	Volume in drive C is Local Disk
530	Volume Serial Number is 34CE-24DF
531
532	Directory of C:testtest0307
533
534	07/28/2003 11:58a 362,167 MGB370.050.gz
535	07/28/2003 11:58a 333,005 MGB370.051.gz
536	07/28/2003 11:58a 310,287 MGB370.052.gz
537	07/28/2003 11:58a 358,771 MGB370.053.gz
538	07/28/2003 11:59a 387,282 MGB370.054.gz
539	07/28/2003 11:59a 361,633 MGB370.055.gz
540	07/28/2003 11:59a 383,075 MGB370.056.gz
541	07/28/2003 11:59a 365,844 MGB370.057.gz
542	07/28/2003 11:59a 383,918 MGB370.058.gz
543	07/28/2003 12:00p 372,712 MGB370.059.gz
544	10 File(s) 3,618,694 bytes
545
546	These compressed files can cosequently be opened with OPENR and the
547	/COMPRESSED keyword.
548
549	<h3>Version history</h3>
550
551	<h4>Version</h4>
552	$Id: read_ftp.pro 157 2006-08-21 09:01:50Z navarro $
553
554	<h4>History</h4>
555
556
557
558	<h3>Known issues</h3>
559
560
561	<h4>Todo items</h4>
562	seb: que fait-on de "syntax" au debut du header?
563	give examples with date in year 0 (should not exists but may happen)
564
565
566
567
568
569
570
571
572
573
574
575	<font size="-3"><p> </p></font>
576	<hr size="1" color="#CCCCCC"/>
577
578
579
580
581	<p><font color="gray" size="-3">  Produced by IDLdoc 2.0 on Tue Aug 29 14:50:05 2006.</font></p>
582
583	</body>
584	</html>

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

Download in other formats: