Grupo cniElementValue

Estas funciones recuperan el valor del elemento de sintaxis especificado.

Sintaxis

CciSize cniElementBitArrayValue(
  int*           returnCode,
  CciElement*    targetElement,
  const struct   CciBitArray* value);
CciBool cniElementBooleanValue(
  int*           returnCode,
  CciElement*    targetElement);
CciSize cniElementByteArrayValue(
  int*           returnCode,
  CciElement*    targetElement,
  const struct   CciByteArray* value);
CciSize cniElementCharacterValue(
  int*           returnCode,
  CciElement*    targetElement,
  const CciChar* value,
  CciSize        length);
struct CciDate cniElementDateValue(
  int*           returnCode,
  CciElement*    targetElement);
CciSize cniElementDecimalValue(
  int*           returnCode,
  CciElement*    targetElement,
  const CciChar* value,
  CciSize        length);
struct CciTimestamp cniElementGmtTimestampValue(
  int*           returnCode,
  CciElement*    targetElement);
struct CciTime cniElementGmtTimeValue(
  int*           returnCode,
  CciElement*    targetElement);
CciInt cniElementIntegerValue(
  int*           returnCode,
  CciElement*    targetElement);
CciReal cniElementRealValue(
  int*           returnCode,
  CciElement*    targetElement);
struct CciTimestamp cniElementTimestampValue(
  int*           returnCode,
  CciElement*    targetElement);
struct CciTime cniElementTimeValue(
  int*           returnCode,
  CciElement*    targetElement);

Parámetros

returnCode
Código de retorno de la función (salida).
targetElement
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

  • Si las funciones se ejecutan correctamente, se devuelve el valor del elemento de destino.
  • Si difiere el tamaño de datos de un elemento, se devuelve el tamaño de datos correcto.
  • Si la longitud especificada es demasiado corta, el código de error se establece en CCI_BUFFER_TOO_SMALL.
  • Si se produce un error, el parámetro returnCode indica la causa de dicho error.

Ejemplo

 numberOfChars = cniElementCharacterValue(
		 		 &rc, firstChild, (CciChar*)&elementValue, sizeof(elementValue)
		 		 );

if (rc==CCI_BUFFER_TOO_SMALL) {
    free(elementValue);
    elementValue      = (CciChar*)malloc(numberOfChars * sizeof(CciChar));
    numberOfChars     = cniElementCharacterValue(
                  &rc, firstChild, (CciChar*)&elementValue, sizeof(elementValue));
  }

Conceptos relacionados
Nodos de proceso de mensajes definidos por el usuario
Nodos de salida definidos por el usuario

Tareas relacionadas
Creación de un nodo de proceso de mensajes en C

Referencia relacionada
Funciones de programa de utilidad de nodo de lenguaje C
cniElementAsBitstream
cniElementName
cniElementType
cniElementValueState
cniElementValueType
cniElementValueValue
Grupo cniSetElementValue