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).
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 element name, returnCode is set to CCI_BUFFER_TOO_SMALL, and the number of bytes required is returned.
  • For any other failures, CCI_FAILURE is returned, and returnCode indicates the reason for the error.

Related concepts
User-defined message processing nodes
User-defined output nodes

Related tasks
Creating a message processing node in C

Related reference
C language node utility functions
cniElementAsBitstream
cniElementNamespace
cniElementType
cniElementValue group
cniElementValueState
cniElementValueType
cniElementValueValue
cniSetElementName
cpiSetElementName