Grupo cpiElementValue

Finalidad

Estas funciones obtienen el valor del elemento de sintaxis especificado.

Sintaxis

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);

Parámetros

returnCode
Recibe el código de retorno de la función (salida).
targetElement
Especifica la dirección del objeto de elemento de sintaxis de destino (entrada).
value
Dirección de un almacenamiento intermedio de salida en el que se almacena el valor del elemento de sintaxis (entrada). Sólo se utiliza en llamadas de función relevantes.
length
Longitud del almacenamiento intermedio de salida, en caracteres, especificada mediante el parámetro value (entrada). Sólo se utiliza en llamadas de función relevantes.

Valores de retorno

Se devuelve el valor del elemento.

En algunos casos, por ejemplo, cpiElementCharacterValue o cpiElementDecimalValue, si el almacenamiento intermedio no es lo suficientemente grande para recibir los datos, estos no se escriben en el almacenamiento intermedio. El tamaño del almacenamiento intermedio requerido se pasa como valor de retorno, y returnCode se establece en CCI_BUFFER_TOO_SMALL.

Si se produce un error, returnCode indica la causa de dicho error.

Conceptos relacionados
Analizadores definidos por el usuario
Extensiones definidas por el usuario

Tareas relacionadas
Creación de un analizador en C

Referencia relacionada
cpiElementName
cpiElementType
cpiElementValueValue
Funciones de programa de utilidad de analizador