cpiElementValue

Purpose

Optional function to get the value of a specified element. It is invoked by the broker when the value of a syntax element is to be retrieved. It provides an opportunity for a user-defined parser to override the behavior for retrieving element values.

Defined In Type Member
CPI_VFT Optional iFpElementValue

Syntax

const CciElementValue* cpiElementValue(
  CciParser*   parser,
  CciElement*  currentElement);

Parameters

parser
The address of the parser object (input).
currentElement
The address of the current syntax element (input).

Return values

The value of the target syntax element object is returned. This will have been returned by the cpiElementValueValue function.

Related concepts
User-defined parsers
User-defined extensions
Related tasks
Creating a parser in C
Related reference
cpiSetElementValue
C parser implementation functions