Add man files and info file. Update README. Tag as 2.99.3.
This commit is contained in:
69
libffi/man/ffi_prep_cif.3
Normal file
69
libffi/man/ffi_prep_cif.3
Normal file
@@ -0,0 +1,69 @@
|
||||
.Dd July 20, 2007
|
||||
.Dt ffi_prep_cif 3
|
||||
.Sh NAME
|
||||
.Nm ffi_prep_cif
|
||||
.Nd Prepare a
|
||||
.Nm ffi_cif
|
||||
structure for use with
|
||||
.Nm ffi_call
|
||||
or
|
||||
.Nm ffi_prep_closure .
|
||||
.Sh SYNOPSIS
|
||||
.In ffi.h
|
||||
.Ft ffi_status
|
||||
.Fo ffi_prep_cif
|
||||
.Fa "ffi_cif *cif"
|
||||
.Fa "ffi_abi abi"
|
||||
.Fa "unsigned int nargs"
|
||||
.Fa "ffi_type *rtype"
|
||||
.Fa "ffi_type **atypes"
|
||||
.Fc
|
||||
.Sh DESCRIPTION
|
||||
The
|
||||
.Nm ffi_prep_cif
|
||||
function prepares a
|
||||
.Nm ffi_cif
|
||||
structure for use with
|
||||
.Nm ffi_call
|
||||
or
|
||||
.Nm ffi_prep_closure .
|
||||
.Fa abi
|
||||
specifies a set of calling conventions to use.
|
||||
.Fa atypes
|
||||
is an array of
|
||||
.Fa nargs
|
||||
pointers to
|
||||
.Nm ffi_type
|
||||
structs that describe the data type, size and alignment of each argument.
|
||||
.Fa rtype
|
||||
points to an
|
||||
.Nm ffi_type
|
||||
that describes the data type, size and alignment of the
|
||||
return value.
|
||||
.Sh RETURN VALUES
|
||||
Upon successful completion,
|
||||
.Nm ffi_prep_cif
|
||||
returns
|
||||
.Nm FFI_OK .
|
||||
It will return
|
||||
.Nm FFI_BAD_TYPEDEF
|
||||
if
|
||||
.Fa cif
|
||||
is
|
||||
.Nm NULL
|
||||
or
|
||||
.Fa atypes
|
||||
or
|
||||
.Fa rtype
|
||||
is malformed. If
|
||||
.Fa abi
|
||||
does not refer to a valid ABI,
|
||||
.Nm FFI_BAD_ABI
|
||||
will be returned. Available ABIs are
|
||||
defined in
|
||||
.Nm <ffitarget.h>
|
||||
.
|
||||
.Sh SEE ALSO
|
||||
.Xr ffi 3 ,
|
||||
.Xr ffi_call 3 ,
|
||||
.Xr ffi_prep_closure 3
|
||||
Reference in New Issue
Block a user