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
cniGetParserClassName
Use this function to get the parser class name that is associated with the specified syntax element.
Syntax
CciSize cniGetParserClassName(
int* returnCode,
CciElement* targetElement,
const CciChar* value,
CciSize length);
Parameters
- returnCode
- The return code from the function (output). Possible return codes are:
- CCI_SUCCESS
- CCI_EXCEPTION
- CCI_INV_ELEMENT_OBJECT
- CCI_INV_DATA_POINTER
- CCI_INV_DATA_BUFLEN
- CCI_INV_BUFFER_TOO_SMALL
- targetElement
- The address of the element for which the parser class name is to be returned (input).
- value
- The address of an output buffer into which the parser class name is stored (input).
- length
- The length of the output buffer, expressed as the number of CciChar characters, specified in the value parameter (input).
Return values
- If successful, the returnCode parameter indicates CCI_SUCCESS, and the number of characters written to the buffer is returned.
- If the buffer is not large enough to retain the returned name, the returnCode parameter indicates CCI_BUFFER_TOO_SMALL, and the returned value indicates the number of characters required to store the name.
- If other errors occur, CCI_FAILURE is returned, and the returnCode parameter indicates the reason for the error.