Files
doc-fr/reference/ftp/functions/ftp-get-option.xml
T
George Peter Banyard 2b0cfd5ba8 Apply commit 4d1c34c9b7a30cfc3a59641122c707a2812cfed7
[PHP 8.1] Use an FTP\Connection instance instead of a resource
2021-09-24 21:01:19 +01:00

133 lines
3.5 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 4d1c34c9b7a30cfc3a59641122c707a2812cfed7 Maintainer: yannick Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="function.ftp-get-option" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>ftp_get_option</refname>
<refpurpose>Lit différentes options pour la connexion FTP courante</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>int</type><type>bool</type></type><methodname>ftp_get_option</methodname>
<methodparam><type>FTP\Connection</type><parameter>ftp</parameter></methodparam>
<methodparam><type>int</type><parameter>option</parameter></methodparam>
</methodsynopsis>
<para>
<function>ftp_get_option</function> retourne la valeur de l'option
<parameter>option</parameter> depuis la connexion FTP spécifiée.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>ftp</parameter></term>
<listitem>
&ftp.parameter.ftp;
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>option</parameter></term>
<listitem>
<para>
Actuellement, les options suivantes sont supportées :
<table>
<title>Options FTP supportées</title>
<tgroup cols="2">
<tbody>
<row>
<entry><constant>FTP_TIMEOUT_SEC</constant></entry>
<entry>
Retourne le délai de connexion courant utilisé pour les opérations
sur le réseau.
</entry>
</row>
<row>
<entry><constant>FTP_AUTOSEEK</constant></entry>
<entry>
Retourne &true; si cette option est active, &false; sinon.
</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Retourne la valeur en cas de succès, ou &false; si l'option
<parameter>option</parameter> n'est pas supportée. Dans le dernier cas,
un message d'alerte est également envoyé.
</para>
</refsect1>
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
&ftp.changelog.ftp-param;
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Exemple avec <function>ftp_get_option</function></title>
<programlisting role="php">
<![CDATA[
<?php
// Récupération du délai de connexion du flux FTP courant
$timeout = ftp_get_option($ftp, FTP_TIMEOUT_SEC);
?>
]]>
</programlisting>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>ftp_set_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
-->