cciThrowException

Use this function to throw an exception. The exception is thrown by the integration node interface, and includes the specified arguments as exception data.

Using this function

The function, like a C exit call, does not return to the caller. It can throw C++ exceptions. When you use C++ to implement a user-defined extension, you must consider certain caveats. For more information, see Which language to use to implement a user-defined extension.

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 that 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 integration node 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 integration node event log with any inserts that are provided in the variable argument list.

traceText

Trace information that is written into the integration node 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.

Inserts that are larger than 16,384 bytes (16 KiB) including a null terminator are truncated to this size.

Return values

None. If an error occurs, the returnCode parameter indicates the reason for the error.