ftp-set-option.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 96c9d88bad9a7d7d44bfb7f26c226df7ee9ddf26 Maintainer: jesusruiz Status: ready -->
<refentry xml:id='function.ftp-set-option' xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ftp_set_option</refname>
  <refpurpose>Establecer varias opciones FTP de tiempo de ejecución</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>
   Esta función controla diversas opciones de tiempo de ejecución para la secuencia FTP 
   especificada.
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>ftp_stream</parameter></term>
     <listitem>
      <para>
       El identificador de enlace de la conexión FTP.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>option</parameter></term>
     <listitem>
      <para>
       Actualmente, se admiten las siguientes opciones:
       <table>
        <title>Opciones FTP de tiempo de ejecución soportadas</title>
        <tgroup cols="2">
         <tbody>
          <row>
           <entry><constant>FTP_TIMEOUT_SEC</constant></entry>
           <entry>
            Cambia el tiempo de espera en segundos usado para todas las funciones 
   de red. <parameter>value</parameter> debe ser un número entero
            mayor que 0. El tiempo de espera predeterminado es 90 segundos.
           </entry>
          </row>
          <row>
           <entry><constant>FTP_AUTOSEEK</constant></entry>
           <entry>
            Cuando se activa, las peticiones GET o PUT con un parámetro 
            <parameter>resumepos</parameter> o <parameter>startpos</parameter>
            buscarán primero la posición solicitada dentro del archivo.
            Este parámetro es activado por defecto.
           </entry>
          </row>
         </tbody>
        </tgroup>
       </table>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>value</parameter></term>
     <listitem>
      <para>
       Este parámetro depende de qué <parameter>option</parameter> se elige 
       para ser alterado.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Devuelve &true; si la opción pudo ser establecida; &false; de lo contrario. 
   Un mensaje de advertencia será lanzado si la <parameter>option</parameter>
   no es soportada o el <parameter>value</parameter> pasado no coincide con 
   el valor esperado para la <parameter>option</parameter> especificada.
  </para>
 </refsect1>
 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Ejemplo de <function>ftp_set_option</function></title>
    <programlisting role="php">
<![CDATA[
<?php
// Establecer el tiempo de espera de red a 10 segundos
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
-->