CPXXgetprobname and CPXgetprobname

The routine CPXXgetprobname/CPXgetprobname accesses the name of the problem set via the call to CPXXcreateprob/CPXcreateprob.

int CPXXgetprobname( CPXCENVptr env, CPXCLPptr lp, char * buf_str, CPXSIZE bufspace, CPXSIZE * surplus_p )

int CPXgetprobname( CPXCENVptr env, CPXCLPptr lp, char * buf_str, int bufspace, int * surplus_p )

Description

The routine CPXXgetprobname/CPXgetprobname accesses the name of the problem set via the call to CPXXcreateprob/CPXcreateprob.

Note: If the routine returns CPXERR_NEGATIVE_SURPLUS, then the value *surplus_p is negative and specifies the difference between the memory provided and the memory required (in bytes).

Arguments

env: A pointer to the CPLEX environment as returned by CPXXopenCPLEX/CPXopenCPLEX.
lp: A pointer to a CPLEX problem object as returned by CPXXcreateprob/CPXcreateprob.
buf_str: A pointer to a buffer of size bufspace. May be NULL if bufspace is 0 (zero).
bufspace: An integer specifying the length of the array buf_str. May be 0 (zero).
surplus_p: A pointer to an integer to contain the difference between bufspace and the amount of memory required to store the problem name. A nonnegative value of surplus_p specifies that the length of the array buf_str was sufficient. A negative value specifies that the length of the array was insufficient and that the routine could not complete its task. In this case, CPXXgetprobname/CPXgetprobname returns the value CPXERR_NEGATIVE_SURPLUS, and the negative value of surplus_p specifies an upper limit on the amount of insufficient space in the array buf_str.

Return

The routine returns 0 (zero) if successful and nonzero if an error occurs. The value CPXERR_NEGATIVE_SURPLUS specifies that insufficient space was available in the buf_str array to hold the problem name.

Example


status = CPXgetprobname (env, lp, cur_probname, lenname,
		  &surplus);