<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/book.ffi.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'ja',
  ),
  'this' => 
  array (
    0 => 'class.ffi.php',
    1 => 'FFI',
    2 => 'C のコードやデータへの主要インターフェース',
  ),
  'up' => 
  array (
    0 => 'book.ffi.php',
    1 => 'FFI',
  ),
  'prev' => 
  array (
    0 => 'ffi.examples-complete.php',
    1 => 'PHP/FFI/事前ロードの完全な例',
  ),
  'next' => 
  array (
    0 => 'ffi.addr.php',
    1 => 'FFI::addr',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'ja',
    'path' => 'reference/ffi/ffi.xml',
  ),
  'history' => 
  array (
  ),
  'extra_header_links' => 
  array (
    'rel' => 'alternate',
    'href' => '/manual/en/feeds/class.ffi.atom',
    'type' => 'application/atom+xml',
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="class.ffi" class="reference">

 <h1 class="title">C のコードやデータへの主要インターフェース</h1>
 

 <div class="partintro"><p class="verinfo">(PHP 7 &gt;= 7.4.0, PHP 8)</p>


  <div class="section" id="ffi.intro">
   <h2 class="title">はじめに</h2>
   <p class="simpara">
    このクラスのオブジェクトは、ファクトリーメソッドである <span class="methodname"><a href="ffi.cdef.php" class="methodname">FFI::cdef()</a></span> や
    <span class="methodname"><a href="ffi.load.php" class="methodname">FFI::load()</a></span>、<span class="methodname"><a href="ffi.scope.php" class="methodname">FFI::scope()</a></span> によって作成されます。
    定義された C の変数は FFI インスタンスのプロパティとして利用可能となり、
    定義された C の関数は FFI インスタンスのメソッドとして利用可能となります。
    宣言された C の型は、<span class="methodname"><a href="ffi.new.php" class="methodname">FFI::new()</a></span> や <span class="methodname"><a href="ffi.type.php" class="methodname">FFI::type()</a></span> を使って
    新しい C のデータ構造を作成するのに使用できます。
   </p>
   <p class="simpara">
    FFI 定義のパースや共有ライブラリの読み込みには長い時間がかかることがあります。
    Web 環境において、各 HTTP リクエストでこれを行うのは不便です。
    しかし、FFI 定義やライブラリを PHP の起動時に事前ロードし、FFI オブジェクトを必要なときにインスタンス化することが可能です。
    ヘッダーファイルは特殊な define である <code class="literal">FFI_SCOPE</code> によって拡張することができ
    (例: <code class="code">#define FFI_SCOPE &quot;foo&quot;</code>。デフォルトのスコープは &quot;C&quot; です)、
    事前ロード中に <span class="methodname"><a href="ffi.load.php" class="methodname">FFI::load()</a></span> によって読み込むことができます。
    これによって、永続的なバインディングが作成されます。
    こうして作られたバインディングは、<span class="methodname"><a href="ffi.scope.php" class="methodname">FFI::scope()</a></span> を通じて後続する全リクエストで利用可能となります。
    詳しくは <a href="ffi.examples-complete.php" class="link">PHP/FFI/事前ロードの完全な例</a>
    を参照してください。
   </p>
   <p class="simpara">
    複数の C のヘッダーファイルを同一のスコープへと事前ロードできます。
   </p>
  </div>


  <div class="section" id="ffi.synopsis">
   <h2 class="title">クラス概要</h2>


   <div class="classsynopsis"><div class="classsynopsisinfo">
    
     <span class="modifier">final</span>
     <span class="modifier">class</span> <strong class="classname"><strong class="classname">FFI</strong></strong>
     {</div>

    <div class="classsynopsisinfo classsynopsisinfo_comment">/* 定数 */</div>
    <div class="fieldsynopsis">
     <span class="modifier">public</span>
     <span class="modifier">const</span>
     <span class="type"><a href="language.types.integer.php" class="type int">int</a></span>
      <var class="fieldsynopsis_varname"><a href="class.ffi.php#ffi.constants.biggest-alignment"><var class="varname">__BIGGEST_ALIGNMENT__</var></a></var>;</div>


    <div class="classsynopsisinfo classsynopsisinfo_comment">/* メソッド */</div>
    <div class="methodsynopsis dc-description">
   <span class="modifier">public</span> <span class="modifier">static</span> <span class="methodname"><a href="ffi.addr.php" class="methodname">addr</a></span>(<span class="methodparam"><span class="type"><a href="class.ffi-cdata.php" class="type FFI\CData">FFI\CData</a></span> <code class="parameter reference">&$ptr</code></span>): <span class="type"><a href="class.ffi-cdata.php" class="type FFI\CData">FFI\CData</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="modifier">static</span> <span class="methodname"><a href="ffi.alignof.php" class="methodname">alignof</a></span>(<span class="methodparam"><span class="type"><span class="type"><a href="class.ffi-cdata.php" class="type FFI\CData">FFI\CData</a></span>|<span class="type"><a href="class.ffi-ctype.php" class="type FFI\CType">FFI\CType</a></span></span> <code class="parameter reference">&$ptr</code></span>): <span class="type"><a href="language.types.integer.php" class="type int">int</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="modifier">static</span> <span class="methodname"><a href="ffi.arraytype.php" class="methodname">arrayType</a></span>(<span class="methodparam"><span class="type"><a href="class.ffi-ctype.php" class="type FFI\CType">FFI\CType</a></span> <code class="parameter">$type</code></span>, <span class="methodparam"><span class="type"><a href="language.types.array.php" class="type array">array</a></span> <code class="parameter">$dimensions</code></span>): <span class="type"><a href="class.ffi-ctype.php" class="type FFI\CType">FFI\CType</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="ffi.cast.php" class="methodname">cast</a></span>(<span class="methodparam"><span class="type"><span class="type"><a href="class.ffi-ctype.php" class="type FFI\CType">FFI\CType</a></span>|<span class="type"><a href="language.types.string.php" class="type string">string</a></span></span> <code class="parameter">$type</code></span>, <span class="methodparam"><span class="type"><span class="type"><a href="class.ffi-cdata.php" class="type FFI\CData">FFI\CData</a></span>|<span class="type"><a href="language.types.integer.php" class="type int">int</a></span>|<span class="type"><a href="language.types.float.php" class="type float">float</a></span>|<span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span>|<span class="type"><a href="language.types.null.php" class="type null">null</a></span></span> <code class="parameter reference">&$ptr</code></span>): <span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="class.ffi-cdata.php" class="type FFI\CData">FFI\CData</a></span></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="modifier">static</span> <span class="methodname"><a href="ffi.cdef.php" class="methodname">cdef</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$code</code><span class="initializer"> = &quot;&quot;</span></span>, <span class="methodparam"><span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.string.php" class="type string">string</a></span></span> <code class="parameter">$lib</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span>): <span class="type"><a href="class.ffi.php" class="type FFI">FFI</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="modifier">static</span> <span class="methodname"><a href="ffi.free.php" class="methodname">free</a></span>(<span class="methodparam"><span class="type"><a href="class.ffi-cdata.php" class="type FFI\CData">FFI\CData</a></span> <code class="parameter reference">&$ptr</code></span>): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="modifier">static</span> <span class="methodname"><a href="ffi.isnull.php" class="methodname">isNull</a></span>(<span class="methodparam"><span class="type"><a href="class.ffi-cdata.php" class="type FFI\CData">FFI\CData</a></span> <code class="parameter reference">&$ptr</code></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="modifier">static</span> <span class="methodname"><a href="ffi.load.php" class="methodname">load</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$filename</code></span>): <span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="class.ffi.php" class="type FFI">FFI</a></span></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="modifier">static</span> <span class="methodname"><a href="ffi.memcmp.php" class="methodname">memcmp</a></span>(<span class="methodparam"><span class="type"><span class="type"><a href="language.types.string.php" class="type string">string</a></span>|<span class="type"><a href="class.ffi-cdata.php" class="type FFI\CData">FFI\CData</a></span></span> <code class="parameter reference">&$ptr1</code></span>, <span class="methodparam"><span class="type"><span class="type"><a href="language.types.string.php" class="type string">string</a></span>|<span class="type"><a href="class.ffi-cdata.php" class="type FFI\CData">FFI\CData</a></span></span> <code class="parameter reference">&$ptr2</code></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$size</code></span>): <span class="type"><a href="language.types.integer.php" class="type int">int</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="modifier">static</span> <span class="methodname"><a href="ffi.memcpy.php" class="methodname">memcpy</a></span>(<span class="methodparam"><span class="type"><a href="class.ffi-cdata.php" class="type FFI\CData">FFI\CData</a></span> <code class="parameter reference">&$to</code></span>, <span class="methodparam"><span class="type"><span class="type"><a href="class.ffi-cdata.php" class="type FFI\CData">FFI\CData</a></span>|<span class="type"><a href="language.types.string.php" class="type string">string</a></span></span> <code class="parameter reference">&$from</code></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$size</code></span>): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="modifier">static</span> <span class="methodname"><a href="ffi.memset.php" class="methodname">memset</a></span>(<span class="methodparam"><span class="type"><a href="class.ffi-cdata.php" class="type FFI\CData">FFI\CData</a></span> <code class="parameter reference">&$ptr</code></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$value</code></span>, <span class="methodparam"><span class="type"><a href="language.types.integer.php" class="type int">int</a></span> <code class="parameter">$size</code></span>): <span class="type"><a href="language.types.void.php" class="type void">void</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="ffi.new.php" class="methodname">new</a></span>(<span class="methodparam"><span class="type"><span class="type"><a href="class.ffi-ctype.php" class="type FFI\CType">FFI\CType</a></span>|<span class="type"><a href="language.types.string.php" class="type string">string</a></span></span> <code class="parameter">$type</code></span>, <span class="methodparam"><span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span> <code class="parameter">$owned</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong></span></span>, <span class="methodparam"><span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span> <code class="parameter">$persistent</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong></span></span>): <span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="class.ffi-cdata.php" class="type FFI\CData">FFI\CData</a></span></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="modifier">static</span> <span class="methodname"><a href="ffi.scope.php" class="methodname">scope</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$name</code></span>): <span class="type"><a href="class.ffi.php" class="type FFI">FFI</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="modifier">static</span> <span class="methodname"><a href="ffi.sizeof.php" class="methodname">sizeof</a></span>(<span class="methodparam"><span class="type"><span class="type"><a href="class.ffi-cdata.php" class="type FFI\CData">FFI\CData</a></span>|<span class="type"><a href="class.ffi-ctype.php" class="type FFI\CType">FFI\CType</a></span></span> <code class="parameter reference">&$ptr</code></span>): <span class="type"><a href="language.types.integer.php" class="type int">int</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="modifier">static</span> <span class="methodname"><a href="ffi.string.php" class="methodname">string</a></span>(<span class="methodparam"><span class="type"><a href="class.ffi-cdata.php" class="type FFI\CData">FFI\CData</a></span> <code class="parameter reference">&$ptr</code></span>, <span class="methodparam"><span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="language.types.integer.php" class="type int">int</a></span></span> <code class="parameter">$size</code><span class="initializer"> = <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong></span></span>): <span class="type"><a href="language.types.string.php" class="type string">string</a></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="methodname"><a href="ffi.type.php" class="methodname">type</a></span>(<span class="methodparam"><span class="type"><a href="language.types.string.php" class="type string">string</a></span> <code class="parameter">$type</code></span>): <span class="type"><span class="type"><a href="language.types.null.php" class="type null">?</a></span><span class="type"><a href="class.ffi-ctype.php" class="type FFI\CType">FFI\CType</a></span></span></div>
<div class="methodsynopsis dc-description"><span class="modifier">public</span> <span class="modifier">static</span> <span class="methodname"><a href="ffi.typeof.php" class="methodname">typeof</a></span>(<span class="methodparam"><span class="type"><a href="class.ffi-cdata.php" class="type FFI\CData">FFI\CData</a></span> <code class="parameter reference">&$ptr</code></span>): <span class="type"><a href="class.ffi-ctype.php" class="type FFI\CType">FFI\CType</a></span></div>

   }</div>


  </div>

  <div class="section" id="class.ffi.constants">
   <h2 class="title">定義済み定数</h2>
   <dl>
    
     <dt id="ffi.constants.biggest-alignment"><strong><code><a href="class.ffi.php#ffi.constants.biggest-alignment">FFI::__BIGGEST_ALIGNMENT__</a></code></strong></dt>
     <dd>
      <span class="simpara"/>
     </dd>
    
   </dl>
  </div>
 </div>

 






































































































<h2>目次</h2><ul class="chunklist chunklist_reference"><li><a href="ffi.addr.php">FFI::addr</a> — C のデータへのアンマネージドなポインターを作成する</li><li><a href="ffi.alignof.php">FFI::alignof</a> — アラインメントを取得する</li><li><a href="ffi.arraytype.php">FFI::arrayType</a> — 新しい C の配列型を動的に構築する</li><li><a href="ffi.cast.php">FFI::cast</a> — C の型キャストを実行する</li><li><a href="ffi.cdef.php">FFI::cdef</a> — 新しい FFI オブジェクトを作成する</li><li><a href="ffi.free.php">FFI::free</a> — アンマネージドなデータ構造を解放する</li><li><a href="ffi.isnull.php">FFI::isNull</a> — FFI\CData が NULL ポインターかどうかを調べる</li><li><a href="ffi.load.php">FFI::load</a> — C のヘッダーファイルから C の宣言を読み込む</li><li><a href="ffi.memcmp.php">FFI::memcmp</a> — メモリ領域を比較する</li><li><a href="ffi.memcpy.php">FFI::memcpy</a> — あるメモリ領域を別の領域へコピーする</li><li><a href="ffi.memset.php">FFI::memset</a> — メモリ領域を埋める</li><li><a href="ffi.new.php">FFI::new</a> — C のデータ構造を作成する</li><li><a href="ffi.scope.php">FFI::scope</a> — 事前ロード中にパースされた C の宣言を使って FFI オブジェクトをインスタンス化する</li><li><a href="ffi.sizeof.php">FFI::sizeof</a> — C のデータサイズまたは C の型サイズを取得する</li><li><a href="ffi.string.php">FFI::string</a> — メモリ領域から PHP の文字列を作成する</li><li><a href="ffi.type.php">FFI::type</a> — C の宣言から FFI\CType オブジェクトを作成する</li><li><a href="ffi.typeof.php">FFI::typeof</a> — FFI\CData の FFI\CType を取得する</li></ul>
</div>
<?php manual_footer($setup); ?>