mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-26 22:08:55 +00:00
cbbd9d134a
added in: https://github.com/php/php-src/pull/1668 -- Provided by anonymous 86357 (spee.jeroen@gmail.com) git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@343809 c90b9560-bf6c-de11-be94-00142212c4b1
138 lines
4.1 KiB
XML
138 lines
4.1 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<refentry xml:id='function.ftp-set-option' xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>ftp_set_option</refname>
|
|
<refpurpose>Set miscellaneous runtime FTP options</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>bool</type><methodname>ftp_set_option</methodname>
|
|
<methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>option</parameter></methodparam>
|
|
<methodparam><type>mixed</type><parameter>value</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
This function controls various runtime options for the specified FTP
|
|
stream.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>ftp_stream</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The link identifier of the FTP connection.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>option</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
Currently, the following options are supported:
|
|
<table>
|
|
<title>Supported runtime FTP options</title>
|
|
<tgroup cols="2">
|
|
<tbody>
|
|
<row>
|
|
<entry><constant>FTP_TIMEOUT_SEC</constant></entry>
|
|
<entry>
|
|
Changes the timeout in seconds used for all network related
|
|
functions. <parameter>value</parameter> must be an integer that
|
|
is greater than 0. The default timeout is 90 seconds.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry><constant>FTP_AUTOSEEK</constant></entry>
|
|
<entry>
|
|
When enabled, GET or PUT requests with a
|
|
<parameter>resumepos</parameter> or <parameter>startpos</parameter>
|
|
parameter will first seek to the requested position within the file.
|
|
This is enabled by default.
|
|
</entry>
|
|
</row>
|
|
<row>
|
|
<entry><constant>FTP_USEPASVADDRESS</constant></entry>
|
|
<entry>
|
|
When disabled, PHP will ignore the IP address returned by the FTP server in response to the PASV command and instead use the IP address that was supplied in the ftp_connect().
|
|
<parameter>value</parameter> must be a boolean.
|
|
</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</table>
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>value</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
This parameter depends on which <parameter>option</parameter> is chosen
|
|
to be altered.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
Returns &true; if the option could be set; &false; if not. A warning
|
|
message will be thrown if the <parameter>option</parameter> is not
|
|
supported or the passed <parameter>value</parameter> doesn't match the
|
|
expected value for the given <parameter>option</parameter>.
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>ftp_set_option</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
// Set the network timeout to 10 seconds
|
|
ftp_set_option($conn_id, FTP_TIMEOUT_SEC, 10);
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>ftp_get_option</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
|
|
-->
|