mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-27 22:38:55 +00:00
e4ecfc3da2
Fixed alphabetizing of 'mcal' in manual.sgml. git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@13125 c90b9560-bf6c-de11-be94-00142212c4b1
172 lines
5.2 KiB
Text
172 lines
5.2 KiB
Text
<reference id="ref.ftp">
|
|
<title>FTP functions</title>
|
|
<titleabbrev>FTP</titleabbrev>
|
|
|
|
<partintro>
|
|
<para>
|
|
FTP stands for File Transfer Protocol.
|
|
|
|
<para>
|
|
The following constants are defined when using the FTP module:
|
|
|
|
FTP_ASCII, and
|
|
FTP_BINARY.
|
|
|
|
</partintro>
|
|
|
|
<refentry id="function.ftp-connect">
|
|
<refnamediv>
|
|
<refname>ftp_connect</refname>
|
|
<refpurpose>Opens up an FTP connection</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcdef>int <function>ftp_connect</function></funcdef>
|
|
<paramdef>string <parameter>host</parameter></paramdef>
|
|
</funcsynopsis>
|
|
<para>
|
|
Returns a FTP stream on success, false on error.
|
|
<para>
|
|
<function>ftp_connect</function> opens up a FTP connection to the
|
|
specified <parameter>host</parameter>.
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
|
|
<refentry id="function.ftp-login">
|
|
<refnamediv>
|
|
<refname>ftp_login</refname>
|
|
<refpurpose>Logs in a FTP connection</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcdef>int <function>ftp_login</function></funcdef>
|
|
<paramdef>int <parameter>ftp_stream</parameter></paramdef>
|
|
<paramdef>string <parameter>username</parameter></paramdef>
|
|
<paramdef>string <parameter>password</parameter></paramdef>
|
|
</funcsynopsis>
|
|
<para>
|
|
Returns true on success, false on error.
|
|
<para>
|
|
Logs in the given FTP stream.
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.ftp-chdir">
|
|
<refnamediv>
|
|
<refname>ftp_chdir</refname>
|
|
<refpurpose>Changes directories on a FTP server</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcdef>int <function>ftp_chdir</function></funcdef>
|
|
<paramdef>int <parameter>ftp_stream</parameter></paramdef>
|
|
<paramdef>string <parameter>directory</parameter></paramdef>
|
|
</funcsynopsis>
|
|
<para>
|
|
Returns true on success, false on error.
|
|
<para>
|
|
Changes to the specified <parameter>directory</paraeter>.
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.ftp-nlist">
|
|
<refnamediv>
|
|
<refname>ftp_nlist</refname>
|
|
<refpurpose>Returns a list of files in the given directory.</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcdef>int <function>ftp_nlist</function></funcdef>
|
|
<paramdef>int <parameter>ftp_stream</parameter></paramdef>
|
|
<paramdef>string <parameter>directory</parameter></paramdef>
|
|
</funcsynopsis>
|
|
<para>
|
|
Returns an array of filenames on success, false on error.
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.ftp-get">
|
|
<refnamediv>
|
|
<refname>ftp_get</refname>
|
|
<refpurpose>Downloads a file from the FTP server.</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcdef>int <function>ftp_get</function></funcdef>
|
|
<paramdef>int <parameter>ftp_stream</parameter></paramdef>
|
|
<paramdef>string <parameter>local_file</parameter></paramdef>
|
|
<paramdef>string <parameter>remote_file</parameter></paramdef>
|
|
<paramdef>int <parameter>mode</parameter></paramdef>
|
|
</funcsynopsis>
|
|
<para>
|
|
Returns true on success, false on error.
|
|
<para>
|
|
<function>ftp_get</function> retrieves <parameter>remote_file</parameter>
|
|
from the FTP server, and saves it to <parameter>local_file</parameter>
|
|
locally. The transfer <parameter>mode</parameter> specified must
|
|
be either FTP_ASCII or FTP_BINARY.
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.ftp-put">
|
|
<refnamediv>
|
|
<refname>ftp_put</refname>
|
|
<refpurpose>Uploads a file to the FTP server.</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcdef>int <function>ftp_put</function></funcdef>
|
|
<paramdef>int <parameter>ftp_stream</parameter></paramdef>
|
|
<paramdef>string <parameter>remote_file</parameter></paramdef>
|
|
<paramdef>string <parameter>local_file</parameter></paramdef>
|
|
<paramdef>int <parameter>mode</parameter></paramdef>
|
|
</funcsynopsis>
|
|
<para>
|
|
Returns true on success, false on error.
|
|
<para>
|
|
<function>ftp_put</function> stores <parameter>local_file</parameter>
|
|
on the FTP server, as <parameter>remote_file</parameter>. The transfer
|
|
<parameter>mode</parameter> specified must be either FTP_ASCII or
|
|
FTP_BINARY.
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<refentry id="function.ftp-quit">
|
|
<refnamediv>
|
|
<refname>ftp_quit</refname>
|
|
<refpurpose>Closes an FTP connection</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<funcsynopsis>
|
|
<funcdef>int <function>ftp_quit</function></funcdef>
|
|
<paramdef>int <parameter>ftp_stream</parameter></paramdef>
|
|
</funcsynopsis>
|
|
<para>
|
|
<function>ftp_connect</function> closes <parameter>ftp_stream</parameter>.
|
|
</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
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"../manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
-->
|