cniGetBrokerInfo

Queries the current broker environment (for example, for information about broker name and message flow name). The information is returned in a structure of type CNI_BROKER_INFO_ST.

Syntax

void cniGetBrokerInfo(
  int*                returnCode,
  CciNode*            nodeObject,
  CNI_BROKER_INFO_ST* broker_info_st);

Parameters

returnCode
The return code from the function (output).
Possible return codes are:
  • CCI_SUCCESS
  • CCI_EXCEPTION
  • CCI_INV_NODE_OBJECT
nodeObject
The message flow processing node for which broker environment information is being requested (input).
broker_info_st
The address of a CNI_BROKER_INFO_ST structure that is used to return a message that represents the input destination (input).

Return values

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

Example

  cniGetBrokerInfo(0, ((NODE_CONTEXT_ST *)context)->nodeObject, &broker_info_st);
Related reference
C node utility functions