Initializing help system before first use

problem.setcbdestroy

problem.setcbdestroy


Purpose
Set a user callback to be called when an SLP problem is about to be destroyed
Synopsis

problem.setcbdestroy (callback, data)

callback (prob, my_object)


Arguments
callback 
The function to be called when the SLP problem is about to be destroyed. callback returns an integer value. At present the return value is ignored.
my_prob 
The problem passed to the callback function.
my_object 
The user-defined object passed as object to setcbdestroy.
object 
Address of a user-defined object, which can be used for any purpose by the function. object is passed to callback as my_object.
Example
The following example sets up a callback to be executed before the SLP problem is destroyed:
p.setcbdestroy (CBDestroy, cSol)
The following sample callback function frees the memory associated with the user-defined object:
def CBDestroy (myprob, Obj):
  if (Obj != None):
    Obj.inuse = 0
  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.