This group of functions retrieve the value of the specified syntax element.
Specify the appropriate function from this group that matches the type of data to be retrieved:
CciSize cpiElementBitArrayValue(
int* returnCode,
CciElement* targetElement,
const struct CciBitArray* value);
CciBool cpiElementBooleanValue(
int* returnCode,
CciElement* targetElement);
CciSize cpiElementByteArrayValue(
int* returnCode,
CciElement* targetElement,
const struct CciByteArray* value);
CciSize cpiElementCharacterValue(
int* returnCode,
CciElement* targetElement,
const CciChar* value,
CciSize length);
struct CciDate cpiElementDateValue(
int* returnCode,
CciElement* targetElement);
CciSize cpiElementDecimalValue(
int* returnCode,
CciElement* targetElement,
const CciChar* value,
CciSize length);
struct CciTimestamp cpiElementGmtTimestampValue(
int* returnCode,
CciElement* targetElement);
struct CciTime cpiElementGmtTimeValue(
int* returnCode,
CciElement* targetElement);
CciInt cpiElementIntegerValue(
int* returnCode,
CciElement* targetElement);
CciReal cpiElementRealValue(
int* returnCode,
CciElement* targetElement);
struct CciTimestamp cpiElementTimestampValue(
int* returnCode,
CciElement* targetElement);
struct CciTime cpiElementTimeValue(
int* returnCode,
CciElement* targetElement);
The value of the element is returned.
In some cases, if the buffer is not large enough to receive the data, the data is not written into the buffer. The size of the required buffer is passed as the return value, and returnCode is set to CCI_BUFFER_TOO_SMALL. For example, cpiElementCharacterValue or cpiElementDecimalValue use this technique.
If an error occurs, returnCode indicates the reason for the error.