Grupo cpiElementValue

Finalidade

Funções para obter o valor do elemento de sintaxe especificado.

Sintaxe

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
Recebe o código de retorno da função (saída).
Os possíveis códigos de retorno são:
  • CCI_SUCCESS
  • CCI_EXCEPTION
  • CCI_INV_ELEMENT_OBJECT
  • CCI_INV_DATA_POINTER
  • CCI_INV_DATA_BUFLEN
  • CCI_INV_BUFFER_TOO_SMALL
targetElement
Especifica o endereço do objeto do elemento de sintaxe de destino (entrada).
value
O endereço de um buffer de saída no qual o valor do elemento de sintaxe é armazenado (entrada). Utilizado somente nas chamadas de funções relevantes.
length
O comprimento do buffer de saída, em caracteres, especificado pelo parâmetro value (entrada). Utilizado somente nas chamadas de funções relevantes.

Valores de Retorno

O valor do elemento é retornado.

Em alguns casos, por exemplo, cpiElementCharacterValue ou cpiElementDecimalValue, se o buffer não for grande o suficiente para receber os dados, os dados não serão gravados no buffer. O tamanho do buffer necessário é transmitido como o valor de retorno, e returnCode é definido como CCI_BUFFER_TOO_SMALL.

Se ocorrer um erro, returnCode indicará o motivo do erro.

Conceitos relacionados
Analisadores Definidos pelo Usuário
Extensões Definidas pelo Usuário
Tarefas relacionadas
Criando um Analisador em C
Referências relacionadas
cpiElementName
cpiElementType
cpiElementValueValue
Funções de Utilitários do Analisador C
Avisos | Marcas Registradas | Downloads | Biblioteca | Suporte | Feedback
Direitos Autorais IBM Corporation 1999, 2006 Última Atualização: 1 Sep 2006
as08450_