load.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="ffi.load" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
 <refnamediv>
  <refname>FFI::load</refname>
  <refpurpose>Loads C declarations from a C header file</refpurpose>
 </refnamediv>

 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <modifier>public</modifier> <modifier>static</modifier> <type class="union"><type>FFI</type><type>null</type></type><methodname>FFI::load</methodname>
   <methodparam><type>string</type><parameter>filename</parameter></methodparam>
  </methodsynopsis>
  <para>
   Loads C declarations from a C header file. It is possible to specify shared libraries that should be loaded,
   using special <literal>FFI_LIB</literal> defines in the loaded C header file.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <variablelist>
   <varlistentry>
    <term><parameter>filename</parameter></term>
    <listitem>
     <para>
      The name of a C header file.
     </para>
     <para>
      C preprocessor directives are not supported, i.e. <literal>#include</literal>,
      <literal>#define</literal> and CPP macros do not work, except for special cases
      listed below.
     </para>
     <para>
      The header file <emphasis>should</emphasis> contain a <literal>#define</literal> statement for the
      <literal>FFI_SCOPE</literal> variable, e.g.: <code>#define FFI_SCOPE "MYLIB"</code>.
      Refer to the <link linkend="ffi.intro">class introduction</link> for details.
     </para>
     <para>
      The header file <emphasis>may</emphasis> contain a <literal>#define</literal> statement for the
      <literal>FFI_LIB</literal> variable to specify the library it exposes. If it is
      a system library only the file name is required, e.g.: <code>#define FFI_LIB
      "libc.so.6"</code>.  If it is a custom library, a relative path is required,
      e.g.: <code>#define FFI_LIB "./mylib.so"</code>.
     </para>
    </listitem>
   </varlistentry>
  </variablelist>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   Returns the freshly created <classname>FFI</classname> object, or &null; on failure.
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><methodname>FFI::scope</methodname></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
-->