cciLog

Use cciLog to write an error, warning, or informational event.

The event is logged by the broker interface, and includes the specified arguments as log data.

Syntax

void cciLog(
  int*          returnCode,
  CCI_LOG_TYPE  type,
  char*         file,
  int           line,
  char*         function,
  CciChar*      messageSource,
  int           messageNumber,
  char*         traceText,
                ...);

Parameters

returnCode
The return code from the function (output). Possible return codes are:
  • CCI_SUCCESS
  • CCI_INV_DATA_POINTER
  • CCI_INV_LOG_TYPE
type
The type of event, as defined by CCI_LOG_TYPE (input). Valid values are:
  • CCI_LOG_ERROR
  • CCI_LOG_WARNING
  • CCI_LOG_INFORMATION
file
The source file name where the function was invoked (input). The value is optional, but it is useful for debugging purposes.
line
The line number in the source file where the function was invoked (input). The value is optional, but it is useful for debugging purposes.
function
The function name that invoked the log function (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.

Start of changeTo use the current broker message catalog, specify BIPv600 on all operating systems. Alternatively, you can create your own message catalog.End of change

messageNumber
The message number identifying the event (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 for debugging purposes.
...
A C variable argument list containing 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.

Notices | Trademarks | Downloads | Library | Support | Feedback

Copyright IBM Corporation 1999, 2009Copyright IBM Corporation 1999, 2009.
Last updated : 2009-01-07 15:23:14

as08552_