File: ftp.xml

package info (click to toggle)
phpdoc 20020310-1
  • links: PTS
  • area: main
  • in suites: woody
  • size: 35,272 kB
  • ctags: 354
  • sloc: xml: 799,767; php: 1,395; cpp: 500; makefile: 200; sh: 140; awk: 51
file content (772 lines) | stat: -rw-r--r-- 27,967 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
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
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
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
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
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
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.14 $ -->
 <reference id="ref.ftp">
  <title>FTP 関数</title>
  <titleabbrev>FTP</titleabbrev>

  <partintro>
   <para>
    この拡張モジュールの関数は、&spec.ftp;で定義された File Transfer
    Protocol (FTP)を使用してファイルサーバにアクセスするクライアントの
    実装です。
   </para>
   <para>
    FTP モジュールを使用する際、次の定数が定義されます。
    <constant>FTP_ASCII</constant>および<constant>FTP_BINARY</constant>
   </para>
   <para>
    PHPの設定でFTP関数を使用するためには、PHP 4をインストールする場合、
    オプション <link linkend="install.configure.enable-ftp">
     <option>--enable-ftp</option></link>、PHP 3を使用している場合には、
    <link linkend="install.configure.with-ftp">
     <option>--with-ftp</option></link>を使用する必要があります。
   </para>
   <para>
    <example>
     <title><function>ftp</function> の例</title>
      <programlisting>
<![CDATA[
<?php
// set up basic connection
$conn_id = ftp_connect($ftp_server); 

// login with username and password
$login_result = ftp_login($conn_id, $ftp_user_name, $ftp_user_pass); 

// check connection
if ((!$conn_id) || (!$login_result)) { 
        echo "Ftp connection has failed!";
        echo "Attempted to connect to $ftp_server for user $ftp_user_name"; 
        die; 
    } else {
        echo "Connected to $ftp_server, for user $ftp_user_name";
    }

// upload the file
$upload = ftp_put($conn_id, $destination_file, $source_file, FTP_BINARY); 

// check upload status
if (!$upload) { 
        echo "Ftp upload has failed!";
    } else {
        echo "Uploaded $source_file to $ftp_server as $destination_file";
    }

// close the FTP stream 
ftp_close($conn_id); 
?>
]]>
     </programlisting>
    </example>
   </para>
  </partintro>

  <refentry id="function.ftp-connect">
   <refnamediv>
    <refname>ftp_connect</refname>
    <refpurpose>FTP 接続をオープンする</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>resource</type><methodname>ftp_connect</methodname>
      <methodparam><type>string</type><parameter>host</parameter></methodparam>
      <methodparam choice="opt"><type>int</type><parameter>port</parameter></methodparam>
      <methodparam choice="opt"><type>int</type><parameter>timeout</parameter></methodparam>
     </methodsynopsis>
    <para>
     成功時にFTPストリーム、エラーの場合に&false;を返します。
    </para>
    <para>
     <function>ftp_connect</function>は、指定した
     <parameter>host</parameter>へのFTP接続をオープンします。
     <parameter>port</parameter>パラメータは別のポートに接続することを
     指定します。これを省略するか0にした場合、デフォルトのFTPポート、
     つまり、21が使用されます。
    </para>
    <para>
     パラメータ<parameter>timeout</parameter>は、以降の全てのネットワー
     ク処理のタイムアウトを指定します。省略された場合、デフォルト値は、
     90秒となります。timeoutは、<function>ftp_set_option</function>お
     よび<function>ftp_get_option</function>でいつでも変更および取得可
     能です。
     <note>
      <para>
       このパラメータは、CVS版でのみ利用可能です。
      </para>
     </note>
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.ftp-login">
   <refnamediv>
    <refname>ftp_login</refname>
    <refpurpose>FTP 接続でログインする</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>bool</type><methodname>ftp_login</methodname>
      <methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam>
      <methodparam><type>string</type><parameter>username</parameter></methodparam>
      <methodparam><type>string</type><parameter>password</parameter></methodparam>
     </methodsynopsis>
    <para> 
     指定したFTPストリームにログインします。
    </para>
    <para>
     成功時に&true;、エラー時に&false;を返します。
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.ftp-pwd">
   <refnamediv>
    <refname>ftp_pwd</refname>
    <refpurpose>現在のディレクトリ名を返す</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>string</type><methodname>ftp_pwd</methodname>
      <methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam>
     </methodsynopsis>
    <para>
     カレントのディレクトリを返します。エラーの場合は、&false; を返し
     ます。
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.ftp-cdup">
   <refnamediv>
    <refname>ftp_cdup</refname>
    <refpurpose>親ディレクトリに移動する</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>bool</type><methodname>ftp_cdup</methodname>
      <methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam>
     </methodsynopsis>
    <para> 
     親ディレクトリに移動します。
    </para>
    <para>
     成功時に &true;、エラー時に &false; を返します。
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.ftp-chdir">
   <refnamediv>
    <refname>ftp_chdir</refname>
    <refpurpose>FTP サーバー上でディレクトリを移動する</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>bool</type><methodname>ftp_chdir</methodname>
      <methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam>
      <methodparam><type>string</type><parameter>directory</parameter></methodparam>
     </methodsynopsis>
    <para> 
     指定した<parameter>directory</parameter>に移動します。
    </para>
    <para>
     成功時に&true;、エラー時に&false;を返します。
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.ftp-mkdir">
   <refnamediv>
    <refname>ftp_mkdir</refname>
    <refpurpose>ディレクトリを作成する</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>string</type><methodname>ftp_mkdir</methodname>
      <methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam>
      <methodparam><type>string</type><parameter>directory</parameter></methodparam>
     </methodsynopsis>
    <para> 
     指定した<parameter>directory</parameter>を作成します。
    </para>
    <para>
     成功した時に、新規に作成したディレクトリ名、エラー時に&false;を返
     します。
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.ftp-rmdir">
   <refnamediv>
    <refname>ftp_rmdir</refname>
    <refpurpose>ディレクトリを削除する</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>bool</type><methodname>ftp_rmdir</methodname>
      <methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam>
      <methodparam><type>string</type><parameter>directory</parameter></methodparam>
     </methodsynopsis>
    <para> 
     指定した<parameter>directory</parameter>を削除します。
    </para>
    <para>
     成功時に &true;、エラー時に &false; を返します。
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.ftp-nlist">
   <refnamediv>
    <refname>ftp_nlist</refname>
    <refpurpose>指定したディレクトリのファイルの一覧を返す</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>array</type><methodname>ftp_nlist</methodname>
      <methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam>
      <methodparam><type>string</type><parameter>directory</parameter></methodparam>
     </methodsynopsis>
    <para>
     成功時に指定したディレクトリにあるファイル名の配列を、エラー時に
     &false;を返します。
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.ftp-rawlist">
   <refnamediv>
    <refname>ftp_rawlist</refname>
    <refpurpose>
     指定したディレクトリの詳細なファイル一覧を返す
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>array</type><methodname>ftp_rawlist</methodname>
      <methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam>
      <methodparam><type>string</type><parameter>directory</parameter></methodparam>
     </methodsynopsis>
    <para>
     <function>ftp_rawlist</function> は、FTP LIST コマンドを実行し、
     結果を配列として返します。各配列要素は、一行分のテキストに対応し
     ます。出力に関する処理は全く行われません。結果の解釈の仕方を定義
     するために <function>ftp_systype</function> から返されるシステム
     型IDをを使用することができます。
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.ftp-systype">
   <refnamediv>
    <refname>ftp_systype</refname>
    <refpurpose>
     リモート FTP サーバーのシステム型IDを返す
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>string</type><methodname>ftp_systype</methodname>
      <methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam>
     </methodsynopsis>
    <para>
     リモートシステム型を返します。エラー時には&false;を返します。
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.ftp-pasv">
   <refnamediv>
    <refname>ftp_pasv</refname>
    <refpurpose>パッシブモードをオンまたはオフにする</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>bool</type><methodname>ftp_pasv</methodname>
      <methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam>
      <methodparam><type>bool</type><parameter>pasv</parameter></methodparam>
     </methodsynopsis>
    <para>
     <function>ftp_pasv</function> は、<parameter>pasv</parameter> パ
     ラメータが &true; の場合にパッシブモードをオンにします。
     (<parameter>pasv</parameter> が &false; の場合は、パッシブモードを
     オフにします) パッシモードでは、データ接続はサーバーではなくクラ
     イアントにより初期化されます。
    </para>
    <para>
     成功時に&true;、エラー時に&false;を返します。
    </para>
   </refsect1>
  </refentry>
 
  <refentry id="function.ftp-get">
   <refnamediv>
    <refname>ftp_get</refname>
    <refpurpose>FTPサーバーからファイルをダウンロードする</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>bool</type><methodname>ftp_get</methodname>
      <methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam>
      <methodparam><type>string</type><parameter>local_file</parameter></methodparam>
      <methodparam><type>string</type><parameter>remote_file</parameter></methodparam>
      <methodparam><type>int</type><parameter>mode</parameter></methodparam>
     </methodsynopsis>
    <para>
     <function>ftp_get</function> は、FTPサーバーから
     <parameter>remote_file</parameter>を取得し、ローカルシステムの
     <parameter>local_file</parameter> に保存します。転送モード
     <parameter>mode</parameter>には、<constant>FTP_ASCII</constant>ま
     たは <constant>FTP_BINARY</constant>のどちらかを指定する必要があ
     ります。
    </para>
    <para>
     成功時に &true;、エラー時に &false; を返します。
    </para>
    <para>
     <function>ftp_fget</function>も参照下さい。
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.ftp-fget">
   <refnamediv>
    <refname>ftp_fget</refname>
    <refpurpose>
     FTP サーバーからファイルをダウンロードし、オープン中のファイルに
     保存する
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>bool</type><methodname>ftp_fget</methodname>
      <methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam>
      <methodparam><type>resource</type><parameter>fp</parameter></methodparam>
      <methodparam><type>string</type><parameter>remote_file</parameter></methodparam>
      <methodparam><type>int</type><parameter>mode</parameter></methodparam>
     </methodsynopsis>
    <para>
     <function>ftp_fget</function> は、FTP サーバーから
     <parameter>remote_file</parameter> を取得し、指定したファイルポイ
     ンタ <parameter>fp</parameter> に書きこみます。転送モード
     <parameter>mode</parameter> には、<constant>FTP_ASCII</constant>
     または<constant>FTP_BINARY</constant>のどちらかを指定する必要があ
     ります。
    </para>
    <para>
     成功時に &true;、エラー時に &false; を返します。
    </para>
   </refsect1>
  </refentry>
 
  <refentry id="function.ftp-put">
   <refnamediv>
    <refname>ftp_put</refname>
    <refpurpose>FTP サーバーにファイルをアップロードする</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>bool</type><methodname>ftp_put</methodname>
      <methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam>
      <methodparam><type>string</type><parameter>remote_file</parameter></methodparam>
      <methodparam><type>string</type><parameter>local_file</parameter></methodparam>
      <methodparam><type>int</type><parameter>mode</parameter></methodparam>
     </methodsynopsis>
    <para>
     <function>ftp_put</function> は <parameter>local_file</parameter> を
     <parameter>remote_file</parameter> として FTP サーバーに保存します。
     <parameter>mode</parameter> には、<constant>FTP_ASCII</constant>
     または<constant>FTP_BINARY</constant>
    </para>
    <para>
     成功時に &true;、エラー時に &false; を返します。
    </para>
    <para>
     <example>
      <title><function>ftp_put</function> の例</title>
      <programlisting role="php">
<![CDATA[
$upload = ftp_put($conn_id, $destination_file, $source_file, FTP_ASCII); 
]]>
      </programlisting>
     </example>
    </para>
    </refsect1>
   </refentry>
 
  <refentry id="function.ftp-fput">
   <refnamediv>
    <refname>ftp_fput</refname>
    <refpurpose>
     オープン中のファイルをFTPサーバーにアップロードする
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>bool</type><methodname>ftp_fput</methodname>
      <methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam>
      <methodparam><type>string</type><parameter>remote_file</parameter></methodparam>
      <methodparam><type>resource</type><parameter>fp</parameter></methodparam>
      <methodparam><type>int</type><parameter>mode</parameter></methodparam>
     </methodsynopsis>
    <para>
     <function>ftp_fput</function> は、ファイルポインタ
     <parameter>fp</parameter> からデータをファイルの終端まで
     アップロードします。結果は、FTPサーバーの
     <parameter>remote_file</parameter> に保存されます。
     転送モード <parameter>mode</parameter> には、
     <constant>FTP_ASCII</constant>または
     <constant>FTP_BINARY</constant>のどちらかを指定する必要があります。
    </para>
    <para>
     成功時に &true;、エラー時に &false; を返します。
    </para>
   </refsect1>
  </refentry>
 
  <refentry id="function.ftp-size">
   <refnamediv>
    <refname>ftp_size</refname>
    <refpurpose>指定したファイルのサイズを返す</refpurpose>
   </refnamediv>
    <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>int</type><methodname>ftp_size</methodname>
      <methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam>
      <methodparam><type>string</type><parameter>remote_file</parameter></methodparam>
     </methodsynopsis>
    <para>
     <function>ftp_size</function> はファイルのサイズを返します。エラー
     を生じた場合、またはファイルが存在しない場合、 -1 が返されます。
     全てのサーバーがこの機能をサポートしているわけではないことに注意
     してください。
    </para>
    <para>
     成功時にファイルのサイズ、エラー時に -1 を返します。
    </para>
   </refsect1>
  </refentry>
  
  <refentry id="function.ftp-mdtm">
   <refnamediv>
    <refname>ftp_mdtm</refname>
    <refpurpose>指定したファイルが最後に修正された時間を返す</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>int</type><methodname>ftp_mdtm</methodname>
      <methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam>
      <methodparam><type>string</type><parameter>remote_file</parameter></methodparam>
     </methodsynopsis>
    <para>
     <function>ftp_mdtm</function> はあるファイルについて最後に修正さ
     れた時間を調べ、UNIXタイムスタンプとして返します。エラーを生じた
     場合、またはファイルが存在しない場合、-1 が返されます。全てのサー
     バーがこの機能をサポートしているわけではないことに注意してください。
    </para>
    <para>
     成功時にUNIXのタイムスタンプ、エラー時に -1 を返します。
    </para>
    <note>
     <para>
      <function>ftp_mdtm</function> はディレクトリについては動作しません。
     </para>
    </note>
   </refsect1>
  </refentry>
  
  <refentry id="function.ftp-rename">
   <refnamediv>
    <refname>ftp_rename</refname>
    <refpurpose>ftp サーバー上のファイルの名前を変更する</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>bool</type><methodname>ftp_rename</methodname>
      <methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam>
      <methodparam><type>string</type><parameter>from</parameter></methodparam>
      <methodparam><type>string</type><parameter>to</parameter></methodparam>
     </methodsynopsis>
    <para>
     <function>ftp_rename</function> は、
     FTP ストリーム <parameter>ftp_stream</parameter>において
     <parameter>from</parameter> という名前のファイルまたはディレクトリを
     <parameter>to</parameter> に変更します。
    </para>
    <para>
     成功時に&true;、エラー時に&false;を返します。
    </para>
   </refsect1>
  </refentry>
  
  <refentry id="function.ftp-delete">
   <refnamediv>
    <refname>ftp_delete</refname>
    <refpurpose>ftp サーバー上のファイルを削除する</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>bool</type><methodname>ftp_delete</methodname>
      <methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam>
      <methodparam><type>string</type><parameter>path</parameter></methodparam>
     </methodsynopsis>
    <para>
     <function>ftp_delete</function> は、<parameter>path</parameter>
     で指定したファイルをFTPサーバーから削除します。
    </para>
    <para>
     成功時に&true;、エラー時に&false;を返します。
    </para>
   </refsect1>
  </refentry>
  
  <refentry id="function.ftp-site">
   <refnamediv>
    <refname>ftp_site</refname>
    <refpurpose>SITEコマンドをサーバーに送信する</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>bool</type><methodname>ftp_site</methodname>
      <methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam>
      <methodparam><type>string</type><parameter>cmd</parameter></methodparam>
     </methodsynopsis>
    <para>
     <function>ftp_site</function>は<parameter>cmd</parameter>で
     指定されたコマンドをFTPサーバーに送信します。SITEコマンドは
     規格が統一されていないため、サーバーにより仕様が異なります.
     ファイルのパーミッションやグループメンバーの設定のような
     処理を行う際には有用です。
    </para>
    <para>
     成功時に&true;、エラー発生時に&false;を返します。
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.ftp-close">
   <refnamediv>
    <refname>ftp_close</refname>
    <refpurpose>FTP接続を閉じる</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>void</type><methodname>ftp_close</methodname>
      <methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam>
     </methodsynopsis>
    <note>
     <para>
      この関数はCVS版でのみ利用可能です。
     </para>
    </note>
    <para>
     <function>ftp_close</function>は、
     <parameter>ftp_stream</parameter>を閉じ、リソースを解放します。こ
     のリソースを再使用することはできませんが、
     <function>ftp_connect</function>で新規の接続を作成する必要があり
     ます。
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.ftp-quit">
   <refnamediv>
    <refname>ftp_quit</refname>
    <refpurpose>FTP接続を閉じる</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>void</type><methodname>ftp_quit</methodname>
      <methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam>
     </methodsynopsis>
    <para>
     <function>ftp_quit</function>は、<parameter>ftp_close</parameter>
     のエイリアスです。
    </para>
   </refsect1>
  </refentry>

  <refentry id='function.ftp-exec'>
   <refnamediv>
    <refname>ftp_exec</refname>
    <refpurpose>
     ftpサーバでプログラム実行する
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>bool</type><methodname>ftp_exec</methodname>
      <methodparam><type>resource</type><parameter>stream</parameter></methodparam>
      <methodparam><type>string</type><parameter>command</parameter></methodparam>
     </methodsynopsis>
    <para>
     ftpサーバにSITE EXEC <parameter>command</parameter>リクエストを送
     信する。リクエストを失敗した場合、&false;を返し、その他の場合は、
     コマンドの出力を返します。
    </para>
   </refsect1>
  </refentry>

  <refentry id='function.ftp-set-option'>
   <refnamediv>
    <refname>ftp_set_option</refname>
    <refpurpose>
     FTP実行オプションを設定する
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>bool</type><methodname>ftp_set_option</methodname>
      <methodparam><type>resource</type><parameter>stream</parameter></methodparam>
      <methodparam><type>int</type><parameter>option</parameter></methodparam>
      <methodparam><type>mixed</type><parameter>value</parameter></methodparam>
     </methodsynopsis>
    <note>
     <para>
      この関数はCVS版でのみ利用可能です。
     </para>
    </note>
    <para>
     オプションが設定できる場合に&true;、そうでない場合に&false;を返し
     ます。<parameter>option</parameter>がサポートされていないか、指定
     された<parameter>value</parameter>が指定した
     <parameter>option</parameter>が期待する値に一致しない場合に警告メッ
     セージが発生します。
    </para>
    <para>
     この関数は、指定したFTPストリームに関して種々の実行時オプションを
     制御します。パラメータ<parameter>value</parameter>は変更するパラ
     メータ<parameter>option</parameter>に依存します。
     現在、以下のオプションがサポートされています。
     <table>
      <title>サポートされる実行時FTPオプション</title>
      <tgroup cols="2">
       <tbody>
        <row>
         <entry>FTP_TIMEOUT_SEC</entry>
         <entry>
          全てのネットワーク関連関数に関して秒単位でタイムアウトを変更
          します。パラメータ<parameter>value</parameter>は、int型で、0
          より大きい必要があります。デフォルトのタイムアウトは90秒です。
         </entry>
        </row>
       </tbody>
      </tgroup>
     </table>
    </para>
    <para>
     <example>
      <title><function>ftp_set_option</function>の例</title>
      <programlisting role="php">
<![CDATA[
// Set the network timeout down to 10 seconds
ftp_set_option($conn_id, FTP_TIMEOUT_SEC, 10);
]]>
      </programlisting>
     </example>
    </para>
   </refsect1>
  </refentry>

  <refentry id='function.ftp-get-option'>
   <refnamediv>
    <refname>ftp_get_option</refname>
    <refpurpose>
     カレントのFTPストリームの種々の実行動作を取得する
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>bool</type><methodname>ftp_get_option</methodname>
      <methodparam><type>resource</type><parameter>stream</parameter></methodparam>
      <methodparam><type>int</type><parameter>option</parameter></methodparam>
     </methodsynopsis>
    <note>
     <para>
      この関数は、CVS版でのみ利用可能です。
     </para>
    </note>
    <para>
     成功時に値、指定した<parameter>option</parameter>がサポートされて
     いない場合に&false;を返します。後者では、警告メッセージも発生しま
     す。
    </para>
    <para>
     
     この関数は、指定した<parameter>FTP stream</parameter>に関して指定
     した<parameter>option</parameter>に関する
     <parameter>value</parameter>を返します。現在、以下のオプションが
     サポートされています。
     <table>
      <title>サポートされる実行時FTPオプション</title>
      <tgroup cols="2">
       <tbody>
        <row>
         <entry>FTP_TIMEOUT_SEC</entry>
         <entry>
          ネットワーク関連処理で使用されるカレントのタイムアウトを返し
          ます。
         </entry>
        </row>
       </tbody>
      </tgroup>
     </table>
    </para>
    <para>
     <example>
      <title><function>ftp_get_option</function>の例</title>
      <programlisting role="php">
<![CDATA[
// 指定したFTPストリームのタイムアウトを取得する
$timeout = ftp_get_option($conn_id, FTP_TIMEOUT_SEC);
]]>
      </programlisting>
     </example>
    </para>
   </refsect1>
  </refentry>

</reference>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->