WebSphere Message Brokers
File: as07950_
Writer: Lorraine Waitt

Reference topic

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

cniGetParserClassName

Gets the parser class name 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 any other error occurs, CCI_FAILURE is returned, and the returnCode parameter indicates the reason for the error.
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:41

as07950_ This topic's URL is: