as08557_.htm |
Last updated Friday, 21 July 2017By convention, the return code output parameter of all utility functions is set to indicate successful completion, or an error. The table lists all return codes with their meanings.
These return codes are defined in the BipCci.h header file.
| Return code | Explanation |
|---|---|
| CCI_BUFFER_TOO_SMALL | The output buffer is not large enough to store the requested data. |
| CCI_EXCEPTION | An exception occurred. |
| CCI_EXCEPTION_CONFIGURATION | A configuration exception was detected when invoking the function. 1 |
| CCI_EXCEPTION_CONVERSION | A conversion exception was detected when invoking the function. 1 |
| CCI_EXCEPTION_DATABASE | A database exception was detected when invoking the function. |
| CCI_EXCEPTION_FATAL | A fatal exception was detected when invoking the function. 1 |
| CCI_EXCEPTION_PARSER | A parser exception was detected when invoking the function. 1 |
| CCI_EXCEPTION_RECOVERABLE | A recoverable exception was detected when invoking the function. 1 |
| CCI_EXCEPTION_UNKNOWN | An unknown exception was specified or encountered. |
| CCI_EXCEPTION_USER | A user exception was detected when invoking the function. 1 |
| CCI_FAILURE | A function was unsuccessful. |
| CCI_FAILURE_CONTINUE | cniRun() return value: rollback message processing and continue thread execution |
| CCI_FAILURE_RETURN | cniRun() return value: rollback message processing and return thread to pool |
| CCI_INV_CODEPAGE | An invalid code page number was specified. |
| CCI_INV_CHARACTER | An invalid character was detected in the buffer to be converted. |
| CCI_INV_DATA_BUFLEN | A data buffer length of zero was specified. |
| CCI_INV_DATA_POINTER | A null pointer was specified for the address of an output data area. |
| CCI_INV_ELEMENT_OBJECT | A null pointer was specified for the element object. |
| CCI_INV_FACTORY_NAME | A factory name that is not valid (blank) was specified. |
| CCI_INV_FACTORY_OBJECT | A null pointer was specified for the factory object. |
| CCI_INV_IMPL_FUNCTION | An invalid combination of conditional implementation functions was specified |
| CCI_INV_LENGTH | A length of zero was specified. |
| CCI_INV_LOG_TYPE | The specified log type is not valid. |
| CCI_INV_MESSAGE_CONTEXT | A null pointer was specified for the message context. |
| CCI_INV_MESSAGE_OBJECT | A null pointer was specified for the message object. |
| CCI_INV_NODE_ENV | Attempt to dispatch a thread from a non-input node. |
| CCI_INV_NODE_NAME | A node name that is not valid (blank) was specified. |
| CCI_INV_NODE_OBJECT | A null pointer was specified for the node object. |
| CCI_INV_OBJECT_NAME | Characters specified in the object name were not valid. |
| CCI_INV_PARSER_NAME | A parser class name that is not valid (blank) was specified. |
| CCI_INV_PARSER_OBJECT | A null pointer was specified for the parser object. |
| CCI_INV_SQL_EXPR_OBJECT | A null pointer was specified for an SQL expression value. |
| CCI_INV_STATEMENT | A statement was not specified. |
| CCI_INV_TERMINAL_NAME | A terminal name that is not valid (blank) was specified. |
| CCI_INV_TERMINAL_OBJECT | A null pointer was specified for the terminal object. |
| CCI_INV_TRANSACTION_TYPE | An invalid value was specified for the transaction type. |
| CCI_INV_VFTP | A null pointer was specified for the address of the user-defined extension virtual function pointer table. |
| CCI_MISSING_IMPL_FUNCTION | A mandatory implementation function was not defined in the function pointer table. |
| CCI_NAME_EXISTS | A parser with the same class name already exists. |
| CCI_NO_BUFFER_EXISTS | No buffer exists for the specified parser object. |
| CCI_NO_EXCEPTION_EXISTS | No previous exception was found for this thread. |
| CCI_NO_THREADS_AVAILABLE | No threads were available to be dispatched. |
| CCI_NULL_ADDR | A function that should return an address was unsuccessful; zero is returned instead. |
| CCI_PARSER_NAME_TOO_LONG | The name of the parser class is too long. |
| CCI_SUCCESS | Successful completion. |
| CCI_SUCCESS_CONTINUE | cniRun() return value: commit message processing and continue thread execution |
| CCI_SUCCESS_RETURN | cniRun() return value: commit message processing and return thread to pool |
| CCI_TIMEOUT | cniRun() return value: no message processing but continue thread execution |
Last updated Friday, 21 July 2017