Function

Package

link-load

Signature

get-foreign-symbol name &optional force => result

Arguments

name

A symbol or string.

force

A keyword.

Values

result

A foreign symbol.

Description

This function gets a foreign symbol or it may be used to explicitly register an undefined symbol.

name is a symbol or string to look up or to create as a foreign symbol. If it is a symbol, the symbol looked for is that which the function lisp-name-to-foreign-name would produce. If name is a string, it is taken literally

If supplied and the symbol is not already defined as a foreign symbol, force forces it to be an undefined foreign symbol. This provides a reference to the symbol so that a subsequent call to read-foreign-modules will attempt to resolve it

Example

(get-foreign-symbol 'my-func-not-yet-loaded t)

Notes

It is not usually necessary to use this function.In order to examine whether a foreign symbol is defined, use foreign-symbol-address. The act of defining a foreign function using fli:define-foreign-function makes the symbol undefined, so the use of force is not usually needed.

See also

foreign-symbol-address
lisp-name-to-foreign-name
read-foreign-modules