WebSphere Message Brokers
File: as07560_
Writer: Lorraine Waitt

Reference topic

This build: July 31, 2007 21:37:17

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):
typedef struct broker_info_st {
int	versionId;			/*Structure version identification*/
CCI_STRING_ST brokerName;		/*The label of the broker*/
CCI_STRING_ST executionGroupName;	/*The label of the current execution group*/
CCI_STRING_ST messageFlowName;		/*The label of the current message flow*/
CCI_STRING_ST queueManagerName;		/*The name of the MQ Queue Manager for the broker*/
int	commitCount;			/*Commit count value*/
int	commitInterval;			/*Commit interval value*/
int	coordinatedTransaction;		/*Flag: coordinatedTransaction: 0=no, 1=yes*/
CCI_STRING_ST dataSourceUserId;		/*The userid broker connects to datasource as*/
} CNI_BROKER_INFO_ST;

Return values

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

Example

  cniGetBrokerInfo(&rc, nodeObject, &broker_info_st);
where nodeObject is of type CciNode*
Related reference
C node utility functions
Notices | Trademarks | Downloads | Library | Support | Feedback

Copyright IBM Corporation 1999, 2007Copyright IBM Corporation 1999, 2007. All Rights Reserved.
This build: July 31, 2007 21:37:17

as07560_ This topic's URL is: