eio-fallocate.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: a4fe8cf4c7712c4af6d2b0dc2e3d7090f53f4e21 Maintainer: takagi Status: ready -->

<refentry xml:id="function.eio-fallocate" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>eio_fallocate</refname>
  <refpurpose>呼び出し元が、ファイルに割り当てられたディスク空間を直接操作できるようにする</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>resource</type><methodname>eio_fallocate</methodname>
   <methodparam><type>mixed</type><parameter>fd</parameter></methodparam>
   <methodparam><type>int</type><parameter>mode</parameter></methodparam>
   <methodparam><type>int</type><parameter>offset</parameter></methodparam>
   <methodparam><type>int</type><parameter>length</parameter></methodparam>
   <methodparam
   choice="opt"><type>int</type><parameter>pri</parameter><initializer>EIO_PRI_DEFAULT</initializer></methodparam>
   <methodparam
   choice="opt"><type>callable</type><parameter>callback</parameter><initializer>NULL</initializer></methodparam>
   <methodparam
   choice="opt"><type>mixed</type><parameter>data</parameter><initializer>NULL</initializer></methodparam>

  </methodsynopsis>

  <para>
  <function>eio_fallocate</function>
  呼び出し元が、ファイルに割り当てられたディスク空間を直接操作できるようにします。
  ファイルの指定はファイルディスクリプタ <parameter>fd</parameter> で行い、
  バイト幅の指定は開始位置 <parameter>offset</parameter> とそこからの長さ
  <parameter>length</parameter> で行います。
  </para>

  <note xmlns="http://docbook.org/ns/docbook">
  <title>書き込みモードでのオープンが必須</title>
  <para><constant>EIO_O_CREAT</constant> を
      <constant>EIO_O_WRONLY</constant> あるいは
      <constant>EIO_O_RDWR</constant> と論理 <emphasis>OR</emphasis> しなければいけません。
  </para>
  </note>

 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>fd</parameter></term>
    <listitem>
     <para>
     ストリーム、ソケットリソース、あるいは数値で表したファイルディスクリプタ (たとえば <function>eio_open</function> が返すもの)。
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>mode</parameter></term>
    <listitem>
     <para>現在サポートするフラグは
     <constant>EIO_FALLOC_FL_KEEP_SIZE</constant> (POSIX の定数
       <constant>FALLOC_FL_KEEP_SIZE</constant> と同じ意味) だけです。
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>offset</parameter></term>
    <listitem>
     <para>
     バイト幅の開始位置。
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>length</parameter></term>
    <listitem>
     <para>
     バイト幅の長さ。
     </para>
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>pri</parameter></term>
    <listitem>
    &eio.request.pri.values;
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>callback</parameter></term>
    <listitem>
     &eio.callback.proto;
    </listitem>
   </varlistentry>
   <varlistentry>
    <term><parameter>data</parameter></term>
    <listitem>
     <para>
     <parameter>callback</parameter> に渡す任意の引数。
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   <function>eio_fallocate</function>
   は、成功した場合にリクエストリソースを返します。&return.falseforfailure;
  </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
-->