ftp-alloc.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 4d1c34c9b7a30cfc3a59641122c707a2812cfed7 Maintainer: takagi Status: ready -->
<!-- Credits: mumumu -->
<refentry xml:id="function.ftp-alloc" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>ftp_alloc</refname>
  <refpurpose>アップロードされるファイルのためのスペースを確保する</refpurpose>
 </refnamediv>
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>bool</type><methodname>ftp_alloc</methodname>
   <methodparam><type>FTP\Connection</type><parameter>ftp</parameter></methodparam>
   <methodparam><type>int</type><parameter>size</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter role="reference">response</parameter><initializer>&null;</initializer></methodparam>
  </methodsynopsis>
  <para>
   <literal>ALLO</literal> コマンドを FTP サーバーに送信し、
   アップロードされるファイルのためのスペースを確保します。
  </para>
  <note>
   <para>
    多くの FTP サーバーはこのコマンドをサポートしていません。これらのサーバーの中には、
    「そのコマンドをサポートしていない」という意味で失敗コード（&false;）
    を返すものもあれば 「事前に確保する必要はない」という意味で成功コード（&true;）
    を返すものもあります。このような理由から、事前のスペース確保が明示的に
    要求されているサーバーに対してのみこの関数を使用するようにするとよいでしょう。
   </para>
  </note>
  <para>
  </para>
 </refsect1>
 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>ftp</parameter></term>
     <listitem>
      &ftp.parameter.ftp;
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>size</parameter></term>
     <listitem>
      <para>
       確保したいバイト数。
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>response</parameter></term>
     <listitem>
      <para>
       <parameter>response</parameter> 変数が指定されていた場合、
       サーバーからの応答テキストの内容の参照が格納されます。
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>
 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   &return.success;
  </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_alloc</function> の例</title>
    <programlisting role="php">
<![CDATA[
<?php

$file = "/home/user/myfile";

// サーバーに接続する
$ftp = ftp_connect('ftp.example.com');
$login_result = ftp_login($ftp, 'anonymous', 'user@example.com');

if (ftp_alloc($ftp, filesize($file), $result)) {
  echo "Space successfully allocated on server.  Sending $file.\n";
  ftp_put($ftp, '/incoming/myfile', $file, FTP_BINARY);
} else {
  echo "Unable to allocate space on server.  Server said: $result\n";
}

ftp_close($ftp);

?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>
 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>ftp_put</function></member>
    <member><function>ftp_fput</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
-->