Initializing help system before first use

XPRBinit

XPRBinit

Purpose
Initialize BCL.
Synopsis
int XPRBinit(void);
Return value
0 
function executed successfully,
1 
an error has occurred,
32 
BCL has been set running in Student mode.
Example 
XPRBseterrctrl(0);
if(XPRBinit())
  printf("BCL has not been initialized correctly.
          Please check your Xpress licenses.");
This switches to user error handling and initializes BCL (or performs license test).
Further information
1. This function explicitly initializes BCL, that is it tests whether a license for running this software is available. It is possible to run BCL with a student license; this mode implies restrictions to the available functionality and to the accepted problem size.
2. With BCL C, the initialization is also performed by function XPRBnewprob so that it is not required to call this explicit initialization, particularly for stand-alone model runs. This function may be used if the embedding of BCL into some larger application requires a test of the license at an earlier stage, before even creating any model.
3. In applications that create a large number of problems it is recommended to use the explicit initialization—once only per process for highest efficiency.
4. Note that this function also initializes Xpress Optimizer, so that it is usually not necessary to call XPRSinit separately (the latter is only required if one wishes to continue using the optimizer after terminating BCL).
Related topics
XPRBfree, XPRBnewprob, XPRSinit (see Optimizer Reference Manual).

Parent Topic BCL C library functions

© 2001-2019 Fair Isaac Corporation. All rights reserved. This documentation is the property of Fair Isaac Corporation (“FICO”). Receipt or possession of this documentation does not convey rights to disclose, reproduce, make derivative works, use, or allow others to use it except solely for internal evaluation purposes to determine whether to purchase a license to the software described in this documentation, or as otherwise set forth in a written software license agreement between you and FICO (or a FICO affiliate). Use of this documentation and the software described in it must conform strictly to the foregoing permitted uses, and no other use is permitted.