cpi_get_error_str

Returns an ASCII string associated with the errnum passed to the function.

Prototype

#include txcpi.h

S8 *cpi_get_error_str ( CPI_ERR_TYPE errnum)

Argument

Description

errnum

CPI library error number.


Return values

Return value

Description

Unknown error nnn

No match for the errnum parameter.

NULL

NULL terminated string containing a description of the errnum passed.


Details

When a CPI library function returns CPI_ERROR, use cpi_get_last_error to determine the error code. Then use cpi_get_error_str to convert this errnum into an ASCII string describing the error.