mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-26 22:08:55 +00:00
4ddd40cff5
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@146870 c90b9560-bf6c-de11-be94-00142212c4b1
92 lines
2.7 KiB
XML
92 lines
2.7 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.8 $ -->
|
|
<!-- splitted from ./en/functions/ftp.xml, last change in rev 1.2 -->
|
|
<refentry id="function.ftp-get">
|
|
<refnamediv>
|
|
<refname>ftp_get</refname>
|
|
<refpurpose>Downloads a file from the FTP server</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</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>
|
|
<methodparam choice="opt"><type>int</type><parameter>resumepos</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<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 <constant>FTP_ASCII</constant> or
|
|
<constant>FTP_BINARY</constant>.
|
|
</para>
|
|
<note>
|
|
<para>
|
|
The <parameter>resumepos</parameter> parameter was added in PHP 4.3.0.
|
|
</para>
|
|
</note>
|
|
<para>
|
|
&return.success;
|
|
</para>
|
|
<para>
|
|
<example>
|
|
<title><function>ftp_get</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
|
|
// define some variables
|
|
$local_file = 'local.zip';
|
|
$server_file = 'server.zip';
|
|
|
|
// 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);
|
|
|
|
// try to download $server_file and save to $local_file
|
|
if (ftp_get($conn_id, $local_file, $server_file, FTP_BINARY)) {
|
|
echo "Successfully written to $local_file\n";
|
|
} else {
|
|
echo "There was a problem\n";
|
|
}
|
|
|
|
// close the connection
|
|
ftp_close($conn_id);
|
|
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
<para>
|
|
See also <function>ftp_fget</function>, <function>ftp_nb_get</function> and
|
|
<function>ftp_nb_fget</function>.
|
|
</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:"../../../../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
|
|
-->
|