cpiElementValue-Gruppe

Zweck

Funktionen zum Abrufen des Werts des angegebenen Syntaxelements.

Syntax

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

Parameter

returnCode
Empfängt den Rückkehrcode von der Funktion (Ausgabe). Mögliche Rückkehrcodes sind:
  • CCI_SUCCESS
  • CCI_EXCEPTION
  • CCI_INV_ELEMENT_OBJECT
  • CCI_INV_DATA_POINTER
  • CCI_INV_DATA_BUFLEN
  • CCI_INV_BUFFER_TOO_SMALL
targetElement
Gibt die Adresse des Zielsyntaxelementobjekts an (Eingabe).
value
Die Adresse eines Ausgabepuffers, in dem der Wert des Syntaxelements gespeichert wird (Eingabe). Dieser Parameter wird nur für relevante Funktionsaufrufe verwendet.
length
Die Länge (in Zeichen) des Ausgabepuffers, der im Parameter value angegeben wird (Eingabe). Dieser Parameter wird nur für relevante Funktionsaufrufe verwendet.

Rückgabewerte

Der Wert des Elements wird zurückgegeben.

In manchen Fällen, z. B. bei cpiElementCharacterValue or cpiElementDecimalValue, werden die Daten nicht in den Puffer geschrieben, wenn der Puffer nicht groß genug ist, um die Daten zu empfangen. Die Größe des erforderlichen Puffers wird als Rückgabewert übergeben, und als Wert für returnCode wird CCI_BUFFER_TOO_SMALL festgelegt.

Wenn ein Fehler auftritt, gibt returnCode die Fehlerursache an.

Zugehörige Konzepte
Benutzerdefinierte Parser
Benutzerdefinierte Erweiterungen
Zugehörige Tasks
Parser in C erstellen
Zugehörige Verweise
cpiElementName
cpiElementType
cpiElementValueValue
C-Parser-Dienstprogrammfunktionen
Bemerkungen | Marken | Downloads | Bibliothek | Unterstützung | Rückmeldung
Copyright IBM Corporation 1999, 2006 Letzte Aktualisierung: 18.05.2006
as08450_