WebSphere Message Broker, Version 8.0.0.7
Operating Systems: AIX, HP-Itanium, Linux, Solaris, Windows, z/OS
See information about the latest product version
See information about the latest product version
cciThrowException
Use this function to throw an exception. The exception is thrown by the broker interface, and includes the specified arguments as exception data.
Syntax
void cciThrowException(
int* returnCode,
CCI_EXCEPTION_TYPE type,
char* file,
int line,
char* function,
CciChar* messageSource,
int messageNumber,
char* traceText,
...);
Parameters
- returnCode
- The return code from the function (output). The possible return code is CCI_INV_DATA_POINTER.
- type
- The type of exception (input). Valid values are:
- CCI_FATAL_EXCEPTION
- CCI_RECOVERABLE_EXCEPTION
- CCI_CONFIGURATION_EXCEPTION
- CCI_PARSER_EXCEPTION
- CCI_CONVERSION_EXCEPTION
- CCI_DATABASE_EXCEPTION
- CCI_USER_EXCEPTION
- file
- The source file name where the exception was generated (input). The value is optional, but it is useful for debugging purposes.
- line
- The line number in the source file where the exception was generated (input). The value is optional, but it is useful for debugging purposes.
- function
- The function name which generated the exception (input). The value is optional, but it is useful for debugging purposes.
- messageSource
- The fully-qualified location and name of the Windows message source or the Linux, UNIX, or z/OS® message catalog.
To use the current broker message catalog, specify BIPmsgs on all operating systems. Alternatively, you can create your own message catalog.
- messageNumber
- The message number identifying the exception (input). If messageNumber is specified as zero, it is assumed that a message is not available. If messageNumber is non-zero, the specified message is written into the broker event log with any inserts provided in the variable argument list.
- traceText
- Trace information that is written into the broker service trace log (input). The information is optional, but it is useful in debugging problems.
- ...
- A C variable argument list that contains any message inserts that
accompany the message (input). These inserts are treated as character
strings and the variable arguments are assumed to be of type pointer
to char.
char* characters must be strings in either ASCII (Latin) or EBCDIC (1047).
The last argument in this list must be (char*)0.
Return values
None. If an error occurs, the returnCode parameter indicates the reason for the error.