ftp-set-option.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 4d1c34c9b7a30cfc3a59641122c707a2812cfed7 Maintainer: Avenger Status: ready -->
<!-- CREDITS: mowangjuanzi -->
<refentry xml:id="function.ftp-set-option" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ftp_set_option</refname>
  <refpurpose>设置各种 FTP 运行时选项</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>ftp_set_option</methodname>
   <methodparam><type>FTP\Connection</type><parameter>ftp</parameter></methodparam>
   <methodparam><type>int</type><parameter>option</parameter></methodparam>
   <methodparam><type class="union"><type>int</type><type>bool</type></type><parameter>value</parameter></methodparam>
  </methodsynopsis>
  <para>
   本函数控制指定 FTP 连接的各种运行时选项。
  </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>
       目前支持以下选项：
       <table>
        <title>所支持的 FTP 运行时选项</title>
        <tgroup cols="2">
         <tbody>
          <row>
           <entry><constant>FTP_TIMEOUT_SEC</constant></entry>
           <entry>
            改变网络传输的超时时间。参数
            <parameter>value</parameter> 必须为整数且大于 0。默认的超时时间为 90 秒。
           </entry>
          </row>
          <row>
           <entry><constant>FTP_AUTOSEEK</constant></entry>
           <entry>
            当此选项打开时，带 <parameter>resumepos</parameter>
            或 <parameter>startpos</parameter> 参数的GET 或 PUT 请求
            将先检索到文件中指定的位置。此选项默认是打开的。
           </entry>
          </row>
          <row>
           <entry><constant>FTP_USEPASVADDRESS</constant></entry>
           <entry>
            当此选项禁用时，PHP 会忽略掉 FTP 服务器通过 PASV 命令返回的 IP 地址，直接使用在 ftp_connect()
            中指定的地址。<parameter>value</parameter> 参数必须是布尔型。
           </entry>
          </row>
         </tbody>
        </tgroup>
       </table>
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>value</parameter></term>
     <listitem>
      <para>
       本参数取决于要修改哪个 <parameter>option</parameter>。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   如果选项能够被设置，返回 &true;，否则返回 &false;。如果参数 <parameter>option</parameter>
   不被支持或者给定的参数 <parameter>value</parameter> 的值与参数
   <parameter>option</parameter> 不匹配，则会同时返回一条警告信息。
  </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><function>ftp_set_option</function> 示例</title>
    <programlisting role="php">
<![CDATA[
<?php
// 设置网络传输超时时间为 10 秒
ftp_set_option($ftp, 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
-->