WebSphere Message Broker, Version 8.0.0.7
Operating Systems: AIX, HP-Itanium, Linux, Solaris, Windows, z/OS
See information about the latest product version
See information about the latest product version
cniGetBrokerInfo
Use this function to query 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 user ID that broker uses to connect to the data source*/ CCI_STRING_ST applicationName; /*The label of the application that owns the message flow*/ CCI_STRING_ST libraryName; /*The label of the library that owns the message flow*/ } CNI_BROKER_INFO_ST;
Note: The dataSourceUserId parameter returns an
empty string. The parameter is included to maintain compatibility
with previous versions of WebSphere® Message
Broker that
require a broker database.
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*