Initializing help system before first use

XSLPgetfuncobject

XSLPgetfuncobject

Purpose
Retrieve the address of one of the objects which can be accessed by the user functions
Synopsis
int XPRS_CC XSLPgetfuncobject(int *ArgInfo, int ObjType, void **Address)
Arguments
ArgInfo 
The array of argument information for the user function.
ObjType 
An integer indicating which object is to be returned. The following values are defined:
XSLP_XSLPPROBLEM 
The Xpress NonLinear problem pointer;
XSLP_XPRSPROBLEM 
The Xpress Optimizer problem pointer;
XSLP_GLOBALFUNCOBJECT 
The Global Function Object;
XSLP_USERFUNCOBJECT 
The User Function Object for the current function;
XSLP_INSTANCEFUNCOBJECT 
The Instance Function Object for the current instance;
Address 
Pointer to hold the address of the object.
Example
The following example retrieves the number of the function and the problem pointer. It then retrieves the internal name by which the function is known. 
char fName[60];
int fNum;
XSLPprob Prob;
void *Object;

XSLPgetfuncinfo(ArgInfo, NULL, NULL,
                NULL, NULL, NULL, NULL,
                &fNum, NULL);
XSLPgetfuncobject(ArgInfo, XSLP_XSLPPROBLEM, &Object);
Prob = (XSLPprob) Object;
XSLPgetnames(Prob, XSLP_USERFUNCNAMES, fName, fNum, fNum);
Further information

For functions which have no current instance because the function does not have instances, the Instance Function Object will be NULL.

For functions which have no current instance because the function was called directly from another user function, the Instance Function Object will be that set by the calling function.


Related topics
XSLPchgfuncobject, XSLPchguserfuncobject, XSLPgetfuncobjectV, XSLPgetuserfuncobject, XSLPsetfuncobject, XSLPsetuserfuncobject

Parent Topic Library functions