cniDeleteMessage

Use this function to delete the specified message object. For every call to the cniCreateMessage function, you must include a matching call to cniDeleteMessage to return allocated resources when the processing on the output message has been completed.

Syntax

void cniDeleteMessage(
  int*         returnCode,
  CciMessage*  message);

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 to be deleted (input).

Return values

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

Example

   cniDeleteMessage(0, outMsg);