mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-24 21:08:55 +00:00
ff19661e8e
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@82260 c90b9560-bf6c-de11-be94-00142212c4b1
76 lines
2.2 KiB
XML
76 lines
2.2 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.3 $ -->
|
|
<!-- splitted from ./en/functions/ftp.xml, last change in rev 1.30 -->
|
|
<refentry id='function.ftp-get-option'>
|
|
<refnamediv>
|
|
<refname>ftp_get_option</refname>
|
|
<refpurpose>Retrieves various runtime behaviours of the current FTP stream</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>mixed</type><methodname>ftp_get_option</methodname>
|
|
<methodparam><type>resource</type><parameter>ftp_stream</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>option</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<note>
|
|
<para>
|
|
This function is only available in CVS.
|
|
</para>
|
|
</note>
|
|
<para>
|
|
Returns the value on success, or &false; if the given
|
|
<parameter>option</parameter> is not supported. In the latter case, a
|
|
warning message is also thrown.
|
|
</para>
|
|
<para>
|
|
This function returns the value for the requested
|
|
<parameter>option</parameter> from the specified <parameter>ftp_stream
|
|
</parameter>. Currently, the following options are supported:
|
|
<table>
|
|
<title>Supported runtime FTP options</title>
|
|
<tgroup cols="2">
|
|
<tbody>
|
|
<row>
|
|
<entry>FTP_TIMEOUT_SEC</entry>
|
|
<entry>Returns the current timeout used for network related
|
|
operations.</entry>
|
|
</row>
|
|
</tbody>
|
|
</tgroup>
|
|
</table>
|
|
</para>
|
|
<para>
|
|
<example>
|
|
<title><function>ftp_get_option</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
// Get the timeout of the given FTP stream
|
|
$timeout = ftp_get_option($conn_id, FTP_TIMEOUT_SEC);
|
|
]]>
|
|
</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:"../../../../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
|
|
-->
|