CPXXparamsetgetint and CPXparamsetgetint

The routine CPXXparamsetgetint/CPXparamsetgetint obtains the currently stored value of a CPLEX parameter of type CPXINT from a parameter set.

int CPXXparamsetgetint( CPXCENVptr env, CPXCPARAMSETptr ps, int whichparam, CPXINT * ival_p)

int CPXparamsetgetint( CPXCENVptr env, CPXCPARAMSETptr ps, int whichparam, CPXINT * ival_p)

Description

The routine CPXXparamsetgetint/CPXparamsetgetint obtains the currently stored value of a CPLEX parameter of type CPXINT from a parameter set. If the parameter is not in the parameter set then an error code is returned.

The CPLEX Parameters Reference Manual provides a list of parameters with their types, options, and default values.

Arguments

env: A pointer to the CPLEX environment as returned by CPXXopenCPLEX/CPXopenCPLEX.
ps: A pointer to the CPLEX parameter set as returned by CPXXparamsetcreate/CPXparamsetcreate using env as the environment.
whichparam: The symbolic constant (or reference number) of the parameter for which the value is to be obtained.
ival_p: A pointer to an integer variable to hold the value of the CPLEX parameter.

Return

The routine returns 0 (zero) if successful and nonzero if an error occurs. A possible error code is CPXERR_BAD_PARAM_NUM which indicates that the requested parameter is either not in the parameter set at all or it is in the parameter set but is not of type CPXINT.

Example


        status = CPXparamsetgetint (env, ps, CPXPARAM_Preprocessing_Presolve, &curpreind);

See also Parameter sets and Examples for multiobjective optimization in the CPLEX User's Manual.