<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.eio.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ja',
  ),
  'this' => 
  array (
    0 => 'function.eio-fallocate.php',
    1 => 'eio_fallocate',
    2 => '呼び出し元が、ファイルに割り当てられたディスク空間を直接操作できるようにする',
  ),
  'up' => 
  array (
    0 => 'ref.eio.php',
    1 => 'Eio 関数',
  ),
  'prev' => 
  array (
    0 => 'function.eio-event-loop.php',
    1 => 'eio_event_loop',
  ),
  'next' => 
  array (
    0 => 'function.eio-fchmod.php',
    1 => 'eio_fchmod',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ja',
    'path' => 'reference/eio/functions/eio-fallocate.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.eio-fallocate" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">eio_fallocate</h1>
  <p class="verinfo">(PECL eio &gt;= 0.0.1dev)</p><p class="refpurpose"><span class="refname">eio_fallocate</span> &mdash; <span class="dc-title">呼び出し元が、ファイルに割り当てられたディスク空間を直接操作できるようにする</span></p>

 </div>

 <div class="refsect1 description" id="refsect1-function.eio-fallocate-description">
  <h3 class="title">説明</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>eio_fallocate</strong></span>(<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span> <code class="parameter">$fd</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$mode</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$offset</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$length</code></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$pri</code><span class="initializer"> = EIO_PRI_DEFAULT</span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.callable.php" class="type callable">callable</a></span> <code class="parameter">$callback</code><span class="initializer"> = NULL</span></span>,<br>&nbsp;&nbsp;&nbsp;&nbsp;<span class="methodparam"><span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span> <code class="parameter">$data</code><span class="initializer"> = NULL</span></span><br>): <span class="type"><a href="language.types.resource.php" class="type resource">resource</a></span></div>


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

  <blockquote class="note"><p><strong class="note">注意</strong>: 
  <strong>書き込みモードでのオープンが必須</strong><br />
  <span class="simpara"><strong><code><a href="eio.constants.php#constant.eio-o-creat">EIO_O_CREAT</a></code></strong> を
      <strong><code><a href="eio.constants.php#constant.eio-o-wronly">EIO_O_WRONLY</a></code></strong> あるいは
      <strong><code><a href="eio.constants.php#constant.eio-o-rdwr">EIO_O_RDWR</a></code></strong> と論理 <em>OR</em> しなければいけません。
  </span>
  </p></blockquote>

 </div>


 <div class="refsect1 parameters" id="refsect1-function.eio-fallocate-parameters">
  <h3 class="title">パラメータ</h3>
  <dl>
   
    <dt><code class="parameter">fd</code></dt>
    <dd>
     <span class="simpara">
     ストリーム、ソケットリソース、あるいは数値で表したファイルディスクリプタ (たとえば <span class="function"><a href="function.eio-open.php" class="function">eio_open()</a></span> が返すもの)。
     </span>
    </dd>
   
   
    <dt><code class="parameter">mode</code></dt>
    <dd>
     <span class="simpara">現在サポートするフラグは
     <strong><code><a href="eio.constants.php#constant.eio-falloc-fl-keep-size">EIO_FALLOC_FL_KEEP_SIZE</a></code></strong> (POSIX の定数
       <strong><code>FALLOC_FL_KEEP_SIZE</code></strong> と同じ意味) だけです。
     </span>
    </dd>
   
   
    <dt><code class="parameter">offset</code></dt>
    <dd>
     <span class="simpara">
     バイト幅の開始位置。
     </span>
    </dd>
   
   
    <dt><code class="parameter">length</code></dt>
    <dd>
     <span class="simpara">
     バイト幅の長さ。
     </span>
    </dd>
   
   
    <dt><code class="parameter">pri</code></dt>
    <dd>
    <p class="para">リクエストの優先順位。<strong><code><a href="eio.constants.php#constant.eio-pri-default">EIO_PRI_DEFAULT</a></code></strong>、<strong><code><a href="eio.constants.php#constant.eio-pri-min">EIO_PRI_MIN</a></code></strong>、<strong><code><a href="eio.constants.php#constant.eio-pri-max">EIO_PRI_MAX</a></code></strong> あるいは <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong> を指定します。
<strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong> を渡した場合、<code class="parameter">pri</code> は内部的に
<strong><code><a href="eio.constants.php#constant.eio-pri-default">EIO_PRI_DEFAULT</a></code></strong> となります。
</p>

    </dd>
   
   
    <dt><code class="parameter">callback</code></dt>
    <dd>
     <p class="para">
<code class="parameter">callback</code> 関数が、リクエスト終了時にコールされます。
この関数のプロトタイプは、<div class="example-contents"><div class="phpcode"><code><span style="color: #000000">void callback(mixed $data, int $result[, resource $req]);</span></code></div></div>

に一致しなければなりません。
<dl>

<dt><code class="parameter">data</code></dt>
<dd><p class="para">は、リクエストに渡すカスタムデータです。</p></dd>


<dt><code class="parameter">result</code></dt>
<dd><p class="para">にはリクエスト固有の結果が格納されます。基本的には、対応するシステムコールが返すそのままの値となります。</p></dd>


<dt><code class="parameter">req</code></dt>
<dd><p class="para">はオプションで指定するリクエストリソースです。
<span class="function"><a href="function.eio-get-last-error.php" class="function">eio_get_last_error()</a></span> のような関数で使えます。</p></dd>

</dl>
</p>

    </dd>
   
   
    <dt><code class="parameter">data</code></dt>
    <dd>
     <span class="simpara">
     <code class="parameter">callback</code> に渡す任意の引数。
     </span>
    </dd>
   
  </dl>
 </div>


 <div class="refsect1 returnvalues" id="refsect1-function.eio-fallocate-returnvalues">
  <h3 class="title">戻り値</h3>
  <p class="simpara">
   <span class="function"><strong>eio_fallocate()</strong></span>
   は、成功した場合にリクエストリソースを返します。失敗した場合に <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong> を返します
  </p>
 </div>


</div><?php manual_footer($setup); ?>