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
cniSetAttribute
This function sets the value of an attribute on a specific node instance. It is called by the broker when a configuration request is received that attempts to set the value of a node attribute, or during initialization of the node.
A node receives requests to set attributes for the base. If an unknown attribute value is received, this function must return a non-zero value so that the broker processes the request correctly.
The responsibilities of the node are to:
- Verify that the value of the attribute is correctly specified. If not, a configuration exception should be thrown using the cciThrowException function.
- Store the value of the attribute within the context, which should have been allocated in the cniCreateNodeContext function.
- Throw a configuration exception if an error occurs, by using the cciThrowException function.
Defined In | Type | Member |
---|---|---|
CNI_VFT | Optional | iFpSetAttribute |
Syntax
int cniSetAttribute(
CciContext* context,
CciChar* attrName,
CciChar* attrValue);
Parameters
- context
- The address of the context for the instance of the node, as created by the node and returned by the cniCreateNodeContext function (input).
- attrName
- The name of the attribute whose value is to be set (input).
- attrValue
- The value of the attribute (input).
Return values
If successful, zero is returned. If the name of the attribute does not identify one supported by the node, a non-zero value is returned.