CPXXparamsetgetstr and CPXparamsetgetstr

The routine CPXXparamsetgetstr/CPXparamsetgetstr obtains the currently stored value of a CPLEX string parameter from a parameter set.

int CPXXparamsetgetstr( CPXCENVptr env, CPXCPARAMSETptr ps, int whichparam, char * sval)

int CPXparamsetgetstr( CPXCENVptr env, CPXCPARAMSETptr ps, int whichparam, char * sval)

Description

The routine CPXXparamsetgetstr/CPXparamsetgetstr obtains the currently stored value of a CPLEX string parameter 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.
sval: A pointer to a buffer of length at least CPX_STR_PARAM_MAX to hold the value stored in the parameter set.

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 a string parameter.

Example


        status = CPXparamsetgetstr (env, ps, CPXPARAM_WorkDir, workdirstr);

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