Initializing help system before first use

XPRBfinish, XPRBfree

XPRBfinish, XPRBfree


Purpose
Terminate BCL and release system resources.
Synopsis
int XPRBfinish(void);
int XPRBfree(void);
Return value
0 if function executed successfully, 1 otherwise.
Example
The following tidies up at the end of a BCL session:
XPRBprob prob;
prob = XPRBnewprob(NULL):
 ...
XPRBdelprob(prob);
XPRBfinish();
Further information
Importantly, XPRBfinish does not free memory associated with problems. These should all be removed using the XPRBdelprob function. When running programs that are mainly based on BCL there is no need to call this function since system resources are freed at the end of the program. To the contrary, it may be interesting to be able to reset and free resources if a BCL program is embedded into some larger application that continues to work after the BCL part has finished. If the user does not wish to delete a problem or terminate BCL but wants to free some resources used for storing solution information he may call XPRBresetprob. Note that XPRBfinish also terminates Xpress Optimizer if it has been started through BCL. If the Optimizer has been started with an explicit call to XPRSinit before BCL has been started, then it is not terminated by XPRBfinish.
Related topics