cniFinalize

Use this function to cause the integration node to request parsers to perform finalize processing on the specified message. Finalization is a process that fixes header chains and makes the Properties folder match the headers.

The behavior of this processing is specific to each parser. Some parsers do not support finalization processing.

Call cniFinalize before you propagate a message from the node; for example, before you call cniWriteBuffer.

Syntax

void cniFinalize(
  int*         returnCode,
  CciMessage*  message,
  int          options);

Parameters

returnCode

The return code from the function (output).

Possible return codes are:

CCI_SUCCESS
CCI_EXCEPTION
CCI_INV_MESSAGE_OBJECT

message

The address of the message object for which the element tree is to be finalized (input).

options

Set this parameter to CCI_FINALIZE_NONE.

Return values

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

Example

      cniFinalize(&rc, outMsg, CCI_FINALIZE_NONE);
      retvalue = cniPropagate(
                             &rc, 
                             terminalObject, 
                             localEnvironment, 
                             exceptionList, 
                             outMsg);

      /* Handle errors */