mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-26 13:58:55 +00:00
4ddd40cff5
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@146870 c90b9560-bf6c-de11-be94-00142212c4b1
96 lines
2.9 KiB
XML
96 lines
2.9 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.7 $ -->
|
|
<refentry id="function.ftp-nb-fget">
|
|
<refnamediv>
|
|
<refname>ftp_nb_fget</refname>
|
|
<refpurpose>Retrieves a file from the FTP server and writes it to an open file (non-blocking)</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>int</type><methodname>ftp_nb_fget</methodname>
|
|
<methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam>
|
|
<methodparam><type>resource</type><parameter>handle</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_nb_fget</function> retrieves <parameter>remote_file</parameter>
|
|
from the FTP server, and writes it to the given file pointer,
|
|
<parameter>handle</parameter>. The transfer <parameter>mode</parameter>
|
|
specified must be either <constant>FTP_ASCII</constant> or
|
|
<constant>FTP_BINARY</constant>. The difference between this function and the
|
|
<function>ftp_fget</function> is that this function retrieves the file
|
|
asynchronously, so your program can perform other operations while the
|
|
file is being downloaded.
|
|
</para>
|
|
<para>
|
|
<example>
|
|
<title><function>ftp_nb_fget</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
|
|
// open some file for reading
|
|
$file = 'index.php';
|
|
$fp = fopen($file, 'w');
|
|
|
|
$conn_id = ftp_connect($ftp_server);
|
|
|
|
$login_result = ftp_login($conn_id, $ftp_user_name, $ftp_user_pass);
|
|
|
|
// Initate the download
|
|
$ret = ftp_nb_fget($conn_id, $fp, $file, FTP_BINARY);
|
|
while ($ret == FTP_MOREDATA) {
|
|
|
|
// Do whatever you want
|
|
echo ".";
|
|
|
|
// Continue downloading...
|
|
$ret = ftp_nb_continue($conn_id);
|
|
}
|
|
if ($ret != FTP_FINISHED) {
|
|
echo "There was an error downloading the file...";
|
|
exit(1);
|
|
}
|
|
|
|
// close filepointer
|
|
fclose($fp);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
<para>
|
|
Returns <constant>FTP_FAILED</constant>, <constant>FTP_FINISHED</constant>, or
|
|
<constant>FTP_MOREDATA</constant>.
|
|
</para>
|
|
<para>
|
|
See also <function>ftp_nb_get</function>,
|
|
<function>ftp_nb_continue</function>, <function>ftp_fget</function>, and
|
|
<function>ftp_get</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
|
|
-->
|