CPXNETgetprobname

Description

This function accesses the name of the network problem stored in a CPLEX network problem object.

Return Value

If the operation is successful, CPXNETgetprobname() returns the value 0; if not, it returns a nonzero value to indicate an error. The value CPXERR_NEGATIVE_SURPLUS indicates that there was not enough space in the buf array to hold the names.

Synopsis

int CPXNETgetprobname (CPXENVptr env,
                       CPXNETptr net,
                       char *buf,
                       int bufspace,
                       int *surplus_p);

Arguments


CPXENVptr env

The pointer to the CPLEX environment as returned by one of the CPXopenCPLEX() routines.

CPXNETptr net

A pointer to a CPLEX network problem object as returned by CPXNETcreateprob().

char *buf

Buffer into which the problem name is copied.

int bufspace

Size of the buf array in bytes.

int *surplus_p

Pointer to an integer to which the difference between bufspace and the number of characters required to store the problem name is returned. A non-negative value indicates that namestore was sufficient. A negative value indicates that it was insufficient. In this case CPXERR_NEGATIVE_SURPLUS is returned and the negative value of surplus_p indicates the amount of insufficient space in the buf array.

Example

status = CPXNETgetprobname (env, net, name);