cpiElementName

Zweck

Diese Funktion ruft den Namen des Zielsyntaxelements ab. Der Name des Syntaxelements wurde zuvor mit cniSetElementName oder cpiSetElementName festgelegt.

Syntax

Ccisize           cpiElementName(
int*            returnCode,
CciElement*            targetElement,
const CciChar*  value,
CciSize         length);

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
Gibt die Adresse eines Puffers an, in den der Elementname kopiert wird (Eingabe).
length
Die Länge (in Zeichen) des Puffers, der im Parameter value angegeben wird (Eingabe).

Rückgabewerte

Bei erfolgreicher Ausführung wird der Elementname in den angegebenen Puffer kopiert, und die Anzahl der kopierten Zeichen des Typs CciChar wird zurückgegeben. Wenn der Puffer für den Elementnamen nicht groß genug ist, wird als Wert für returnCode CCI_BUFFER_TOO_SMALL festgelegt, und die erforderliche Zeichenanzahl wird zurückgegeben. Bei anderen Fehlern wird CCI_FAILURE zurückgegeben, und returnCode gibt die Fehlerursache an.

Beispiel

cpiElementName(&rc;, element, (CciChar*)&elementName;, sizeof(elementName));
Zugehörige Konzepte
Benutzerdefinierte Parser
Benutzerdefinierte Erweiterungen
Zugehörige Tasks
Parser in C erstellen
Zugehörige Verweise
cpiElementType
cpiElementValue-Gruppe
cpiElementValueValue
C-Parser-Dienstprogrammfunktionen
Bemerkungen | Marken | Downloads | Bibliothek | Unterstützung | Rückmeldung
Copyright IBM Corporation 1999, 2006 Letzte Aktualisierung: 18.05.2006
as08430_