Specifications

Intel
®
Image Processing Library Reference Manual
3-10
3
The IPL_ERROR() macro simply calls the iplError() function by default.
This macro is used by other error macros. By changing
IPL_ERROR() you
can modify the error reporting behavior without changing a single line of
source code.
The
IPL_RSTERR() macro resets the error status to IPL_StsOk, thus
clearing any error condition. This macro should be used by an application
when it decides to ignore an error condition.
Status Codes
Some of the status codes used by the library are listed in Table 3-1. Status
codes are integers, not an enumerated type. This allows an application to
extend the set of status codes beyond those used by the library itself. Negative
codes indicate errors, while non-negative codes indicate success. To obtain a
short string describing the status code use
iplErrorStr() function.
Table 3-1 iplError() Status Codes
Status Code Value Description
IPL_StsOk
0
No error. The iplError() function does
nothing if called with this status code.
IPL_StsBackTrace
-1 Implements a back-trace of the function calls
that lead to an error. If IPL_ERRCHK()
detects that a function call resulted in an
error, it calls IPL_ERROR() with this status
code to provide further context information
for the user.
IPL_StsError
-2 An error of unknown origin, or of an origin
not correctly described by the other error
codes.
IPL_StsInternal
-3 An internal “consistency” error, often the
result of a corrupted state structure. These
errors are typically the result of a failed
assertion.
continued
☞