Initializing help system before first use

XPRBgetbyname

XPRBgetbyname

Purpose
Retrieve an object by its name.
Synopsis
void *XPRBgetbyname(XPRBprob prob, const char *name, int type);
Arguments
prob 
Reference to a problem.
name 
The name of the object.
type 
The type of the object sought. This is one of:
XPRB_VAR 
a BCL variable;
XPRB_ARR 
a BCL array of variables;
XPRB_CTR 
a BCL constraint;
XPRB_SOS 
a BCL SOS;
XPRB_IDX 
a BCL index set.
Return value
Reference to a BCL object of the indicated type if function executed successfully, NULL if object not found or in case of an error.
Example
This example finds the variable with the name abc3. 
XPRBprob prob;
XPRBvar x1;
 ...
x1 = XPRBgetbyname(prob, "abc3", XPRB_VAR);
Further information
The function returns the reference to an object of the indicated type or NULL. The same name may be used for objects of different types within one problem definition. This function can only be used if the names dictionary is enabled (functions XPRBsetdictionarysize).
Related topics
XPRBsetdictionarysize, XPRBnewname.

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.