register-foreign-callable

$Revision: 5.0.2.2 $

Function

Package: FOREIGN-FUNCTIONS

Arguments: (name &optional index-or-reuse convert-to-c-types)

The name argument must be a symbol defined with defun-foreign-callable.

The index-or-reuse argument can be a fixnum to select a specific table entry to replace, or the symbol :reuse to specify that if the a function with the same name is already registered, the function will be replaced at the same index.

If convert-to-c-types is specified, then an attempt will be made to convert the return value to a foreign value, otherwise the return value is returned unchanged. It is important to note that thought the default is nil, the most often the desired effect is obtained by setting this option to t. The default of nil is retained for compatibility reasons. This is described in a little more detail in the description of defun-foreign-callable.

Returns 5 values

an integer address which can be passed to C and used as the address of the function
a table-index value
the previous table entry
a fixnum representing the calling convention
the number of bytes of stack space needed for this function's arguments

See ftype.htm for information on foreign types in Allegro CL. See foreign_functions.htm for general information on foreign functions in Allegro CL.

The general documentation description is in introduction.htm. The index in index.htm.