php-doc-en/reference/ftp/functions/ftp-nb-continue.xml
Máté Kocsis 18680fd168 Generate FTP methodsynopses based on stubs
Co-authored-by: Christoph M. Becker <cmbecker69@gmx.de>

Closes GH-305.
2021-01-01 23:20:38 +01:00

86 lines
2.1 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.ftp-nb-continue" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ftp_nb_continue</refname>
<refpurpose>Continues retrieving/sending a file (non-blocking)</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>int</type><methodname>ftp_nb_continue</methodname>
<methodparam><type>resource</type><parameter>ftp</parameter></methodparam>
</methodsynopsis>
<para>
Continues retrieving/sending a file non-blocking.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>ftp</parameter></term>
<listitem>
<para>
The link identifier of the FTP connection.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Returns <constant>FTP_FAILED</constant> or <constant>FTP_FINISHED</constant>
or <constant>FTP_MOREDATA</constant>.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title><function>ftp_nb_continue</function> example</title>
<programlisting role="php">
<![CDATA[
<?php
// Initiate the download
$ret = ftp_nb_get($my_connection, "test", "README", FTP_BINARY);
while ($ret == FTP_MOREDATA) {
// Continue downloading...
$ret = ftp_nb_continue($my_connection);
}
if ($ret != FTP_FINISHED) {
echo "There was an error downloading the file...";
exit(1);
}
?>
]]>
</programlisting>
</example>
</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
-->