Chapitre 11. Scilab Gateway API

Table des matières

1. How to
Calling a scilab function (macros) from a C gateway — Calling a scilab function (macros) from a C interface
How to access a matrix — How to access a matrix using the C gateway functions
How to check parameters — how to check parameter send to an interface using the C gateway functions
How to create and access a list — How to create and access a list using the C gateway functions
How to deal with optional parameters — how to deal with optional parameters send to an interface using the C gateway functions
CheckColumn — C interface function which checks if a parameter send to the C function is a column vector or not
CheckDimProp — C interface function which checks the comatibility between 2 arguments send to the C function
CheckDims — C interface function which checks if a parameter send to the C function has the required dimensions
CheckLength — C interface function which checks the length of a vector send as a parameter to the C function
CheckLhs — C macro which checks the number of output arguments present in the calling Scilab function.
CheckRhs — C macro which checks the number of input arguments present in the calling Scilab function.
CheckRow — C interface function which checks if a parameter send to the C function is a row vector or not
CheckSameDims — C interface function which checks if two parameters send to the C function have the same size
CheckScalar — C interface function which checks if a parameter send to the C function is a scalar or not
CheckSquare — C interface function which checks if a parameter send to the C function is a square matrix or not
CheckVector — C interface function which checks if a parameter send to the C function is a vector (column or row) or not
CreateListVarFrom — a C interface function which allows to create a new Scilab parameter in a [mt]list
CreateListVarFromPtr — a C interface function which allows to create a new Scilab parameter from a pointer in a [mt]list
CreateVar — a C gateway function which allows to create a new Scilab parameter
FindOpt — C gateway function find the position of an optional argument given its name
FirstOpt — C gateway function which returns the position of the first optional parameter
GetListRhsVar — a C gateway function which allows to access a parameter stored in a [mt]list transmitted to a Scilab function
GetRhsVar — a C gateway function which allows to access an argument transmitted to a Scilab function
GetType — C gateway function which returns the type of a parameter in the Scilab memory
IsOpt — C gateway function which checks if a parameter is optional and returns the name of the parameter
Lhs — A C gateway function which provides the number of output arguments present in the calling Scilab function
LhsVar — a C gateway function which specifies which parameters created inside the C gateway will be returned as an output argument into Scilab.
NumOpt — C gateway function which returns the number of optional parameters sent to a C function
OverLoad — C gateway function which tells Scilab to look for another overloaded function
Rhs — A C gateway function which provides the number of input arguments present in the calling Scilab function
Scierror — C gateway function which displays an error message to the user (same profil as the printf function) and returns an integer value specifying an error level
Scilab C Types — the C types available in a C gateway
get_optionals — C gateway function which initialize the list of optional parameters
istk — Return a pointer to an integer to access data stored at a given position in the Scilab memory
sci_types — a C enumeration which defines the types available for a variable
sciprint — A C gateway function which displays standard messages to the user (same profil as the C printf function)
stk — Return a pointer to a double to access data stored at a given position in the Scilab memory

1. How to