array ( 0 => 'index.php', 1 => 'PHP Manual', ), 'head' => array ( 0 => 'UTF-8', 1 => 'en', ), 'this' => array ( 0 => 'ffi.load.php', 1 => 'FFI::load', 2 => 'Loads C declarations from a C header file', ), 'up' => array ( 0 => 'class.ffi.php', 1 => 'FFI', ), 'prev' => array ( 0 => 'ffi.isnull.php', 1 => 'FFI::isNull', ), 'next' => array ( 0 => 'ffi.memcmp.php', 1 => 'FFI::memcmp', ), 'alternatives' => array ( ), 'source' => array ( 'lang' => 'en', 'path' => 'reference/ffi/ffi/load.xml', ), 'history' => array ( ), ); $setup["toc"] = $TOC; $setup["toc_deprecated"] = $TOC_DEPRECATED; $setup["parents"] = $PARENTS; manual_setup($setup); contributors($setup); ?>

FFI::load

(PHP 7 >= 7.4.0, PHP 8)

FFI::load — Loads C declarations from a C header file

Description

public static FFI::load(string $filename): ?FFI

Loads C declarations from a C header file. It is possible to specify shared libraries that should be loaded, using special FFI_LIB defines in the loaded C header file.

Parameters

filename
The name of a C header file. C preprocessor directives are not supported, i.e. #include, #define and CPP macros do not work, except for special cases listed below. The header file should contain a #define statement for the FFI_SCOPE variable, e.g.: #define FFI_SCOPE "MYLIB". Refer to the class introduction for details. The header file may contain a #define statement for the FFI_LIB variable to specify the library it exposes. If it is a system library only the file name is required, e.g.: #define FFI_LIB "libc.so.6". If it is a custom library, a relative path is required, e.g.: #define FFI_LIB "./mylib.so".

Return Values

Returns the freshly created FFI object, or null on failure.

Changelog

Version Description
8.3.0 FFI::load() is now allowed in preload scripts when the current system user is the same as the one defined in the opcache.preload_user configuration directive.

See Also