CPXgetsosname

public int CPXgetsosname(CPXCENVptr env, CPXCLPptr lp, char ** name, char * namestore, int storespace, int * surplus_p, int begin, int end)

Definition file: cplex.h

The routine CPXgetsosname accesses a range of special ordered set (SOS) names of a CPLEX problem object. The beginning and end of the range, along with the length of the array in which the SOS names are to be returned, must be specified.

Note

If the value of storespace is 0 (zero), then the negative of the value of *surplus_p returned indicates the total number of characters needed for the array namestore.

Example

 status = CPXgetsosname (env, lp, cur_sosname, cur_sosnamestore,
                         cur_storespace, &surplus, 0,
                         cur_numsos-1);

Parameters:

env	A pointer to the CPLEX environment as returned by `CPXopenCPLEX`.
lp	A pointer to a CPLEX problem object as returned by `CPXcreateprob`.
name	An array of pointers to the SOS names stored in the array `namestore`. This array must be of length at least (`end` - `begin+ 1`). The pointer to the name of SOS `i` is returned in `name[i-begin]`.
namestore	An array of characters where the specified SOS names are to be returned. May be NULL if `storespace` is 0 (zero).
storespace	An integer indicating the length of the array `namestore`. May be 0 (zero).
surplus_p	A pointer to an integer to contain the difference between `storespace` and the total amount of memory required to store the requested names. A nonnegative value of `surplus_p` indicates that `storespace` was sufficient. A negative value indicates that it was insufficient and that the routine could not complete its task. In that case, `CPXgetsosname` returns the value `CPXERR_NEGATIVE_SURPLUS`, and the negative value of the variable `surplus_p` indicates the amount of insufficient space in the array `namestore`.
begin	An integer indicating the beginning of the range of sos names to be returned.
end	An integer indicating the end of the range of sos names to be returned.

Returns:

The routine returns zero if successful and nonzero if an error occurs. The value CPXERR_NEGATIVE_SURPLUS indicates that insufficient space was available in the namestore array to hold the names.