This section describes how the application checks for errors.

An application checks for OpenAPI function errors when the function has completed its tasks, as indicated by the completion flag, gp_completed, in the generic parameter block.

When the function successfully or unsuccessfully completes its tasks, the completion flag is set to TRUE and the callback function is invoked if the callback address is provided in the parameter block. The value of the generic parameter gp_status indicates the success or failure of the function.

A failed task may have additional error information attached to it. To find out if such information exists, an application examines the value of the generic parameter gp_errorHandle. If the handle is non-NULL, the application calls IIapi_getErrorInfo() to retrieve the additional error information.

When an OpenAPI function detects an error, an error code and text describing the error are generated. This information is available through IIapi_getErrorInfo() and the error handle returned in the generic parameters of the function parameter block. When IIapi_getErrorInfo() returns with ge_serverInfoAvail set to FALSE, the error information generated by the OpenAPI and ge_errorCode is set to a particular value.