CXI-Basis-Programmierreferenz / Version 2 / Datenspeicherung / CxiNode / Zeichenketten /

AppendItem - An Zeichenkettenliste anhängen

CxiError CxiNode :: AppendItem (CxiName pname, const char *pval, CxiLong options = 0)
CxiError cxiAppendItem ...P (CxiHandle self, CxiName pname, const char *pval, CxiLong options)

Fügt an eine String-Liste an

pname:
Name einer cxiTypeLst-Variablen oder Pfadangabe und Variablenname

pval:
Hinzuzufügende(r) String(s)

options:
ODER-Verknüpfung je einer Option der folgenden Gruppen:
ART DES PARAMETERS pval:
cxiOptAppendString (=0, Vorgabe): einzelner nullterminierter String;
cxiOptAppendArgs (=1): Argumentstring, mit Leerzeichen getrennt;
VERHALTEN IM FEHLERFALL:
cxiOptAppendSmart (=0, Vorgabe): Liste automatisch anlegen;
cxiOptAppendFail: Variable weder anlegen noch ersetzen;
cxiOptAppendForce: Bestehende Variable ersetzen

return:
0 ok, sonst Fehler

AppendItem fügt hinten an eine bestehende Liste an; dies entspricht InsertItem mit index=cxiMaxInt. Bei Angabe von cxiOptInsertString (Vorgabe) wird pval als ein einzelnes neues Element an die Liste angefügt. Bei cxiOptInsertArgs wird pval wie eine Kommandozeile in mehrere Parameter zerlegt, die dann einzeln in die Liste aufgenommen werden.

Die folgenden Abschnitte beschreiben das Verhalten im Fehlerfall:

cxiOptAppendSmart (Vorgabe): Existiert keine Variable mit dem Namen pname, so wird sie erzeugt. Wurde eine Variable pname mit einem anderen Typ als cxiTypeLst gefunden, so wird der Fehler cxiErrorTypeMismatch gemeldet.

cxiOptAppendFail: Existiert keine Variable mit dem Namen pname, so wird der Fehler cxiErrorVarNotFound zurückgegeben. Existiert eine Variable mit dem Namen pname, die nicht vom Typ cxiTypeLst ist, so wird der Fehler cxiErrorTypeMismatch gemeldet.

cxiOptAppendForce: Existiert keine Variable mit dem Namen pname, so wird sie erzeugt. Existiert eine String-Variable mit dem Namen pname, wird sie automatisch in eine einelementige Liste konvertiert. Wurde eine Variable pname mit einem anderen Typ als cxiTypeLst oder cxiTypeStr gefunden, so wird sie durch eine leere Liste ersetzt.

Die Elemente einer Variable vom Typ cxiTypeLst sind beginnend mit 0 durchnummeriert. Der Parameter index gibt entweder direkt die Nummer des gewünschten Elements an (Werte größer oder gleich 0), oder er ist eine relative Position vom Ende der Liste ausgehend (negativer Wert). Der Wert 0 kennzeichnet also das erste, -1 das letzte Element der Liste.

Portabilität:
Diese Funktionen sind in allen unterstützten Systemen verfügbar.

Aus Kompatibilitätsgründen kann auch noch der alte Funktionsname (cxi)AppendVarLst verwendet werden. Die Funktion (cxi)AppendVarLst ist in allen Versionen definiert und identisch zu (cxi)AppendItem, außer dass für den Parameter options nur die Werte 0 und 1 zulässig sind.

Siehe auch:
InsertItem
DeleteItem
SetLst (mit Beispiel)
GetLst
GetAsNum (mit Beispiel)
GetItem
GetItemStr
GetItemTest
QueryItemCount
FindInList
IsInList
IsEqual...