IBM Integration Bus, Version 10.0.0.9 Operating Systems: AIX, HP-Itanium, Linux, Solaris, Windows, z/OS


cniElementName

Use this function to get the value of the name attribute for the specified syntax element. You must sethe syntax element name previously by 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.

as07890_.htm | Last updated 2017-07-17 12:45:50