Package: cffi

Function free-converted-object

Lambda List

free-converted-object (value type param)

Arguments

foreign-value -- The C object to be freed.
type -- A CFFI type specifier.
params -- The state returned as the second value from convert-to-foreign; used to implement the third argument to free-translated-object.

Return Value

The return value is unspecified.

Details

This is an external interface to the type translation facility. In the implementation, all foreign functions are ultimately defined as type translation wrappers around primitive foreign function invocations.

This function is available mostly for inspection of the type translation process, and possibly optimization of special cases of your foreign function calls.

Its behavior is better described under free-translated-object's documentation.

Examples

  CFFI-USER> (convert-to-foreign "a boat" :string)
  => #<FOREIGN-ADDRESS #x097ACDC0>
  => T
  CFFI-USER> (free-converted-object * :string t)
  => NIL  
 

See also