Initializing help system before first use

XPRMgetprocinfo

XPRMgetprocinfo


Purpose
Get the procedure/function information.
Synopsis
int XPRMgetprocinfo(XPRMproc proc, const char **partyp, int *nbpar, int *type);
Arguments
proc 
Reference to a procedure or function
partyp 
Returned string of parameter types
nbpar 
Returned number of parameters
type 
Returned type of the function or XPRM_TYP_NOT for a procedure
Return value
0 if successful, 1 otherwise.
Further information
This function provides information about a procedure or function. The type can be decoded like for any other identifier of a model. Note that a procedure has no return type (type= XPRM_TYP_NOT). The string of parameter types is a text string describing which parameters are expected by the function, it is its signature. This string is composed with the following characters:
an integer
a real
a text string
a Boolean
a decision variable (type mpvar)
a linear constraint (type linctr)
a range set
an array (of any kind)
a set (of any type)
a list (of any type)
|xxx| 
external type named ` xxx'. A type code may also be given as ` %???' where ` ???' (3 hexadecimal digits) is the code number
!xxx! 
the set named ` xxx'
Andx.t 
an array indexed by ` ndx' of the type ` t'. ` ndx' is a string describing the type of each indexing set. ` ndx' may be omitted in which case any array of type ` t' is a valid parameter.
Et 
a set of type ` t'
Lt 
a list of type ` t'
any type
function with variable number of parameters (this character is the last one of the string)
For instance, the procedure:
proc(n:integer,
     tab:array(range, set of real, myset) of string,
     flag:boolean)
has the signature ``iAIr!myset!.sb''.
Related topics