Initializing help system before first use

XSLPgetuserfuncobject

XSLPgetuserfuncobject


Purpose
Retrieve the address of one of the objects which can be accessed by the user functions
Synopsis
int XPRS_CC XSLPgetuserfuncobject(XSLPprob prob, int Entity, void **Address);
Arguments
Prob 
The current SLP problem.
Entity 
An integer indicating which object is to be defined. The value is interpreted as follows:
The Global Function Object;
n > 0 
The User Function Object for user function number n;
n < 0 
The Instance Function Object for user function instance number -n.
Address 
Pointer to hold the address of the object.
Example
The following example retrieves the Function Object for user function number 3.
void *Obj;
XSLPgetuserfuncobject(Prob, 3, &Obj);
Further information

This function returns the address of one of the objects previously defined by XSLPsetuserfuncobject or XSLPchguserfuncobject

.

As instance numbers are not normally meaningful, this function should only be used to get the values of all Instance Function Objects in order, for example, to free any allocated memory.


Related topics