IBM Integration Bus, Version 9.0.0.8 Operating Systems: AIX, HP-Itanium, Linux, Solaris, Windows, z/OS

See information about the latest product version

cciServiceTrace

Writes a message to service trace, if service trace is active.

The message that is written to service trace has the following format:

<date-time stamp> <threadNumber> +cciServiceTrace <nodeName> <nodeType> <traceText>, <nodeLabel>

Syntax

void cciServiceTrace(
  int*           returnCode,
  CciObject*     object,
  const char*    traceText
);

Parameters

returnCode

Receives the return code from the function (output). A NULL pointer input parameter signifies that the user-defined node does not handle errors. Exceptions thrown during the execution of this call are thrown again to the next upstream node in the flow. If the input parameter is not NULL, output signifies the success status of the call. If an exception occurs during execution, *returnCode is set to CCI_EXCEPTION on output. Use CciGetLastExceptionData to get details of the exception.

object (input)

The address of the object that is to be associated with the trace entry (input). This object can be the address of a CciNode or a CciParser. If you specify a CciNode, the name of that node is written to trace. If you specify a CciParser, the name of the node that created the parser is written to trace. This object is also used to determine if the entry is written to trace. The entry is written only if trace is active for the node. Currently, nodes inherit their trace setting from the message flow.

If this parameter is NULL, the following actions are taken:

<nodeName>, <nodeType>, <nodeLabel>, and <messageFlowLabel> are omitted from the trace entry.
The entry is written based on the trace setting of the integration server.

traceText (input)

A string of characters that ends with NULL (input). This string is written to service trace, and you can use it to correlate trace entries with paths through the source code. For example, you might have several paths through the code that result in the same message (messageSource and messageNumber) being written to trace. traceText can be used to distinguish between these different paths. That is, the traceText string is a static literal string in the source, and therefore the same string is in both the source code file and the formatted trace file.

This string must be in ISO-8859-1 (ibm-819) code page for user-defined extensions running on distributed platforms, and must be in EBCDIC (1047) for user-defined extensions running on z/OS®.

Return values

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

Example

    CciNode*         thisNode = ((NODE_CONTEXT_ST*)context)->nodeObject;

    cciServiceTrace(&rc,(CciObject*)thisNode,">>_Switch_evaluate()");
    checkRC(rc);

as24520_.htm |

Last updated Friday, 21 July 2017