cniRootElement

Gets the root syntax element associated with a specified message. It returns the root element that is associated with (and owned by) the message object identified by the message parameter. When a message object is constructed by the broker, a root element is automatically created.

Syntax

CciElement* cniRootElement(
  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 (input).

Return values

If successful, the address of the root element object is returned. Otherwise, zero (CCI_NULL_ADDR) is returned, and the returnCode parameter indicates the reason for the error.

Example

   inRootElement = cniRootElement(&rc, message);