XSLPsetcbdestroy
XSLPsetcbdestroy |
Purpose
Set a user callback to be called when an SLP problem is about to be destroyed
Synopsis
int XPRS_CC XSLPsetcbdestroy(XSLPprob Prob, int (XPRS_CC *UserFunc) (XSLPprob myProb, void *myObject), void *Object);
Arguments
|
Prob
|
The current SLP problem.
|
|
UserFunc
|
The function to be called when the SLP problem is about to be destroyed.
UserFunc returns an integer value. At present the return value is ignored.
|
|
myProb
|
The problem passed to the callback function.
|
|
myObject
|
The user-defined object passed as
Object to
XSLPsetcbdestroy.
|
|
Object
|
Address of a user-defined object, which can be used for any purpose by the function.
Object is passed to
UserFunc as
myObject.
|
Example
The following example sets up a callback to be executed before the SLP problem is destroyed:
double *cSol; XSLPsetcbdestroy(Prob, CBDestroy, &cSol);
The following sample callback function frees the memory associated with the user-defined object:
int XPRS_CC CBDestroy(XSLPprob MyProb, void *Obj) {
if (*(void**)Obj) free(*(void**)Obj);
return 0;
}
The
Object argument is used here to hold the address of the array
cSol which we assume was assigned using one of the
malloc functions.
Further information
This callback can be used when the problem is about to be destroyed to free any user-defined resources which were allocated during the life of the problem.
Related topics