WebSphere Message Brokers
File: as07890_
Writer: Lorraine Waitt

Reference topic

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

cniElementName

Gets the value of the name attribute for the specified syntax element. The syntax element name will have been set previously using cniSetElementName or cpiSetElementName.

Syntax

CciSize cniElementName(
  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 target syntax element object (input).
value
The address of a buffer into which the element name is copied (input).
length
The length, in characters, specified by the value parameter (input).

Return values

  • If successful, the element name is copied into the supplied buffer and the number of CciChar characters copied is returned.
  • If the buffer is not large enough to contain the attribute value, returnCode is set to CCI_BUFFER_TOO_SMALL, and the number of CciChars required is returned.
  • For any other failures, CCI_FAILURE is returned, and returnCode indicates the reason for the error.
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:38

as07890_ This topic's URL is: