Index | | | Classes | | | Functions |
class DynFunction
Internal representation of dynamically loaded functions. more...
Methods | |
call | Calls the external dynamically loaded function. |
isSafe | Checks if this DynFunction has safety constraints. |
parameters | Returns the parameter constraints that were given for this function. |
retval | Returns the return type constraint that were given for this function. |
toString | Returns a string representation of the function. |
This class cannot be instantiated directly. It is generated by the DynLib.get method on succesful load.
Calls the external dynamically loaded function.
DynFunction.call( [...] ) | |
... | |
Returns: | Either nil, a Falcon item or an instance of DynOpaque. |
The function calls the dynamically loaded function. If the function was loaded by DynLib.get with parameter specificators, input parameters are checked for consistency, and a ParamError may be raised if they don't match. Otherwise, the parameters are passed to the underlying remote functions using this conversion:
If a return specificator was applied in DynLib.get, the function return value is determined by the specificator, otherwise a single integer is returned. The integer is sized after the void* size in the host platform, so it may contain either an integer returned as a status value or an opaque pointer to a structure created by the function.
See also DynLib.get.
Checks if this DynFunction has safety constraints.
DynFunction.isSafe( ) | |
Returns: | True if this function has parameter and return values constraints, false otherwise. |
See also DynLib.get.
Returns the parameter constraints that were given for this function.
DynFunction.parameters( ) | |
Returns: | The parameters given for this function (as a string), or nil if not given. |
See also DynLib.get.
Returns the return type constraint that were given for this function.
DynFunction.retval( ) | |
Returns: | The return type given for this function (as a string), or nil if not given. |
See also DynLib.get.
Returns a string representation of the function.
DynFunction.toString( ) | |
Returns: | A string representation of the function. |
The representation will contain the original parameter list and return values, if given.
Index | | | Classes | | | Functions |