-
Notifications
You must be signed in to change notification settings - Fork 56
/
ftp-fget.xml
170 lines (162 loc) · 4.91 KB
/
ftp-fget.xml
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
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 4d1c34c9b7a30cfc3a59641122c707a2812cfed7 Maintainer: hirokawa Status: ready -->
<!-- CREDITS: takagi,mumumu -->
<refentry xml:id="function.ftp-fget" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ftp_fget</refname>
<refpurpose>FTP サーバーからファイルをダウンロードし、オープン中のファイルに保存する</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>ftp_fget</methodname>
<methodparam><type>FTP\Connection</type><parameter>ftp</parameter></methodparam>
<methodparam><type>resource</type><parameter>stream</parameter></methodparam>
<methodparam><type>string</type><parameter>remote_filename</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>mode</parameter><initializer><constant>FTP_BINARY</constant></initializer></methodparam>
<methodparam choice="opt"><type>int</type><parameter>offset</parameter><initializer>0</initializer></methodparam>
</methodsynopsis>
<para>
<function>ftp_fget</function> は、FTP サーバーから
<parameter>remote_filename</parameter> を取得し、指定したファイルポインタに書きこみます。
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>ftp</parameter></term>
<listitem>
&ftp.parameter.ftp;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>stream</parameter></term>
<listitem>
<para>
オープンされているファイルのポインタ。ここにデータが保存されます。
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>remote_filename</parameter></term>
<listitem>
<para>
リモートファイルのパス。
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>mode</parameter></term>
<listitem>
<para>
転送モード。<constant>FTP_ASCII</constant> または
<constant>FTP_BINARY</constant> のどちらかを指定する必要があります。
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>offset</parameter></term>
<listitem>
<para>
リモートファイル中で、ダウンロードを開始する位置。
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&ftp.changelog.ftp-param;
<row>
<entry>7.3.0</entry>
<entry>
<parameter>mode</parameter> パラメータはオプションになりました。
これより前のバージョンでは、このパラメータは必須でした。
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>ftp_fget</function> の例</title>
<programlisting role="php">
<![CDATA[
<?php
// リモートファイルへのパス。
$remote_file = 'somefile.txt';
$local_file = 'localfile.txt';
// 書き込み用のファイルをオープンします。
$handle = fopen($local_file, 'w');
// 接続を確立します。
$ftp = ftp_connect($ftp_server);
// ユーザー名とパスワードを指定してログインします。
$login_result = ftp_login($ftp, $ftp_user_name, $ftp_user_pass);
// $remote_file をダウンロードし、$handle に保存しようとします。
if (ftp_fget($ftp, $handle, $remote_file, FTP_ASCII, 0)) {
echo "successfully written to $local_file\n";
} else {
echo "There was a problem while downloading $remote_file to $local_file\n";
}
// 接続およびファイルハンドラを閉じます。
ftp_close($ftp);
fclose($handle);
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ftp_get</function></member>
<member><function>ftp_nb_get</function></member>
<member><function>ftp_nb_fget</function></member>
</simplelist>
</para>
</refsect1>
</refentry>
<!-- 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:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->