Gruppo cpiElementValue

Scopo

Queste funzioni consentono di ottenere il valore dell'elemento di sintassi specificato.

Sintassi

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

Parametri

returnCode
Riceve il codice di ritorno dalla funzione (output).
I codici di ritorno possibili sono:
  • CCI_SUCCESS
  • CCI_EXCEPTION
  • CCI_INV_ELEMENT_OBJECT
  • CCI_INV_DATA_POINTER
  • CCI_INV_DATA_BUFLEN
  • CCI_INV_BUFFER_TOO_SMALL
targetElement
Specifica l'indirizzo dell'oggetto elemento di sintassi di destinazione (input).
value
L'indirizzo di un buffer di output in cui viene memorizzato il valore dell'elemento di sintassi (input). Viene utilizzato solo nelle chiamate di funzioni rilevanti.
length
La lunghezza, in caratteri, del buffer di output specificata nel parametro value (input). Viene utilizzato solo nelle chiamate di funzioni rilevanti.

Valori di restituzione

Viene restituito il valore dell'elemento.

In alcuni casi, ad esempio, cpiElementCharacterValue o cpiElementDecimalValue, se il buffer non è sufficiente a ricevere i dati, questi non vengono scritti nel buffer. La dimensione del buffer richiesto viene passata come valore di restituzione e returnCode è impostato su CCI_BUFFER_TOO_SMALL.

Se si verifica un errore, il parametro returnCode indica il motivo dell'errore.

Concetti correlati
Programmi di analisi definiti dall'utente
Estensioni definite dall'utente
Attività correlate
Creazione di un programma di analisi in C
Riferimenti correlati
cpiElementName
cpiElementType
cpiElementValueValue
Funzioni di utilità del programma di analisi in C
Informazioni particolari | Marchi | Download | Libreria | Supporto | Commenti
Copyright IBM Corporation 1999, 2006 Ultimo aggiornamento: ago 17, 2006
as08450_