Initializing help system before first use

getprocinfo

getprocinfo

Purpose
Get the procedure/function information.
Synopsis
int getprocinfo(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.
Example
see getnextproc
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:
i 
an integer
r 
a real
s 
a text string
b 
a Boolean
v 
a decision variable (type mpvar)
c 
a linear constraint (type linctr)
I 
a range set
a 
an array (of any kind)
e 
a set (of any type)
l 
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.
Et 
a set of type ` t'
Lt 
a list of type ` t'
* 
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, real, myset) of string, flag:boolean)
has the signature `` iAIr!myset!.sb''.
Related topics
getnextproc.

Parent Topic Dictionary access

© 2001-2019 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.