<?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 => 'it',
  ),
  'this' => 
  array (
    0 => 'class.ffi.php',
    1 => 'FFI',
    2 => 'Main interface to C code and data',
  ),
  'up' => 
  array (
    0 => 'book.ffi.php',
    1 => 'FFI',
  ),
  'prev' => 
  array (
    0 => 'ffi.examples-complete.php',
    1 => 'A Complete PHP/FFI/preloading Example',
  ),
  'next' => 
  array (
    0 => 'ffi.addr.php',
    1 => 'FFI::addr',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    '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">Main interface to C code and data</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">Introduzione</h2>
   <p class="simpara">
    Objects of this class are created by the factory methods <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> or <span class="methodname"><a href="ffi.scope.php" class="methodname">FFI::scope()</a></span>. Defined C variables
    are made available as properties of the FFI instance, and defined C functions are made available
    as methods of the FFI instance. Declared C types can be used to create new C data structures
    using <span class="methodname"><a href="ffi.new.php" class="methodname">FFI::new()</a></span> and <span class="methodname"><a href="ffi.type.php" class="methodname">FFI::type()</a></span>.
   </p>
   <p class="simpara">
    FFI definition parsing and shared library loading may take significant time. It is not useful
    to do it on each HTTP request in a Web environment. However, it is possible to preload FFI definitions
    and libraries at PHP startup, and to instantiate FFI objects when necessary. Header files
    may be extended with special <code class="literal">FFI_SCOPE</code> defines (e.g. <code class="code">#define FFI_SCOPE &quot;foo&quot;</code>;
    the default scope is &quot;C&quot;) and then loaded by <span class="methodname"><a href="ffi.load.php" class="methodname">FFI::load()</a></span> during preloading.
    This leads to the creation of a persistent binding, that will be available to all the following
    requests through <span class="methodname"><a href="ffi.scope.php" class="methodname">FFI::scope()</a></span>.
    Refer to the <a href="ffi.examples-complete.php" class="link">complete PHP/FFI/preloading example</a>
    for details.
   </p>
   <p class="simpara">
    It is possible to preload more than one C header file into the same scope.
   </p>
  </div>


  <div class="section" id="ffi.synopsis">
   <h2 class="title">Sommario della classe</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">/* Costanti */</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">/* Metodi */</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">Costanti predefinite</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>Indice dei contenuti</h2><ul class="chunklist chunklist_reference"><li><a href="ffi.addr.php">FFI::addr</a> — Creates an unmanaged pointer to C data</li><li><a href="ffi.alignof.php">FFI::alignof</a> — Gets the alignment</li><li><a href="ffi.arraytype.php">FFI::arrayType</a> — Dynamically constructs a new C array type</li><li><a href="ffi.cast.php">FFI::cast</a> — Performs a C type cast</li><li><a href="ffi.cdef.php">FFI::cdef</a> — Creates a new FFI object</li><li><a href="ffi.free.php">FFI::free</a> — Releases an unmanaged data structure</li><li><a href="ffi.isnull.php">FFI::isNull</a> — Checks whether a FFI\CData is a null pointer</li><li><a href="ffi.load.php">FFI::load</a> — Loads C declarations from a C header file</li><li><a href="ffi.memcmp.php">FFI::memcmp</a> — Compares memory areas</li><li><a href="ffi.memcpy.php">FFI::memcpy</a> — Copies one memory area to another</li><li><a href="ffi.memset.php">FFI::memset</a> — Fills a memory area</li><li><a href="ffi.new.php">FFI::new</a> — Creates a C data structure</li><li><a href="ffi.scope.php">FFI::scope</a> — Instantiates an FFI object with C declarations parsed during preloading</li><li><a href="ffi.sizeof.php">FFI::sizeof</a> — Gets the size of C data or types</li><li><a href="ffi.string.php">FFI::string</a> — Creates a PHP string from a memory area</li><li><a href="ffi.type.php">FFI::type</a> — Creates an FFI\CType object from a C declaration</li><li><a href="ffi.typeof.php">FFI::typeof</a> — Gets the FFI\CType of FFI\CData</li></ul>
</div>
<?php manual_footer($setup); ?>