Initializing help system before first use

# problem.getControlInfo

Purpose
Accesses the id number and the type information of a control given its name. A control name may be for example XPRS_PRESOLVE. Names are case-insensitive and may or may not have the XPRS_ prefix. The id number is the constant used to identify the control in the C API. The type information returned will be one of the below integer constants. The function will return an id number of 0 and a type value of xpress.ParameterType.NOTDEFINED if the name is not recognized as a control name. Note that this will occur if the name is an attribute name and not a control name.
Topic areas
Controls and Attributes, Optimizer
Synopsis
`id, type = problem.getControlInfo(name)`
Argument

name: str | The name of the control to be queried. Names are case-insensitive and may or may not have the XPRS_ prefix. A full list of all controls may be found in the Optimizer Reference Manual, or from the list in the xprs.h header file.

Return value

id: int | The id number.
type: ParameterType | The type information. The returned value will be one of the following constants from xprs.h:
xpress.ParameterType.NOTDEFINED | The name was not recognized.
xpress.ParameterType.INT | 32-bit integer.
xpress.ParameterType.INT64 | 64-bit integer.
xpress.ParameterType.DOUBLE | Double precision floating point.
xpress.ParameterType.STRING | String.

Related topics
problem.getAttribInfo.
Parent Topic Xpress problem object methods

© 2001-2026 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.