cpiSetElementValue group

Purpose

Functions to set a value in the specified syntax element.

Syntax

void cpiSetElementBitArrayValue(
  int*                        returnCode,
  CciElement*                 targetElement,
  const struct CciBitArray*   value);
void cpiSetElementByteArrayValue(
  int*                        returnCode,
  CciElement*                 targetElement,
  const struct CciByteArray*  value);
void cpiSetElementBooleanValue(
  int*         returnCode,
  CciElement*  targetElement,
  CciBool      value);
void cpiSetElementCharacterValue(
  int*            returnCode,
  CciElement*     targetElement,
  const CciChar*  value,
  CciSize         length);
void cpiSetElementDateValue(
  int*                   returnCode,
  CciElement*            targetElement,
  const struct CciDate*  value);
void cpiSetElementDecimalValue(
  int*            returnCode,
  CciElement*     targetElement,
  const CciChar*  value);
void cpiSetElementGmtTimestampValue(
  int*                        returnCode,
  CciElement*                 targetElement,  const struct CciTimestamp*  value);
void cpiSetElementGmtTimeValue(
  int*                   returnCode,
  CciElement*            targetElement,
  const struct CciTime*  value);
void cpiSetElementIntegerValue(
  int*         returnCode,
  CciElement*  targetElement,
  CciInt       value);
void cpiSetElementRealValue(
  int*         returnCode,
  CciElement*  targetElement,
  CciReal      value);
void cpiSetElementTimestampValue(
  int*                        returnCode,
  CciElement*                 targetElement,
  const struct CciTimestamp*  value);
void cpiSetElementTimeValue(
  int*                   returnCode,
  CciElement*            targetElement,
  const struct CciTime*  value);

Parameters

returnCode
Receives 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
targetElement
Specifies the address of the target syntax element object (input).
value
The value to be set in the target element (input).
length
The length of the data value, expressed as the number of CciChar characters. Used on relevant function calls only.

Return values

None. If an error occurs, returnCode indicates the reason for the error.

Related concepts
User-defined parsers
User-defined extensions
Related tasks
Creating a parser in C
Related reference
cpiSetElementName
cpiSetElementType
cpiSetElementValueValue
C parser utility functions