AfAbmStwLstGet

AfAbmStwLstGet(int1, int2) : int
Liste der Stichwörter zu einer Arbeitsmappe ermitteln
int1 Nummer der Arbeitsmappe int2 Deskriptor einer leeren Cte-Liste Resultat int Fehlerwert Siehe Verwandte Befehle, AfAbmStwCreate()

Mit der Funktion lassen sich alle Stichwörter zu einer Arbeitsmappe ermitteln. Die Nummer der Arbeitsmappe wird über den Parameter (int1) übergeben.

Im Parameter (int2) muss der Deskriptor einer leeren Cte-Liste übergeben werden, die vor dem Aufruf der Funktion über den Befehl AfCteOpen() angelegt wurde.

Nach dem Aufruf der Funktion ist pro Stichwort ein Objekt in der Cte-Liste vorhanden. Die Objekte können geladen werden und über die Eigenschaft "Name" kann das Stichwort und über die Eigenschaft "Custom" können die weiteren Informationen des Stichworts ausgelesen werden. Die Informationen werden durch Kommas getrennt und liegen in folgender Reihenfolge vor:

1. Suchbereich: ab Zeile
2. Suchbereich: bis Zeile
3. Groß-/Kleinschreibung beachten

Beispiel:

"1,40,1" bedeutet: Stichwort wird in Zeile 1 bis Zeile 40 gesucht.

Dabei wird die Groß-/Kleinschreibung beachtet.

Beispielfunktion zum Ermitteln der einzelnen Informationen:

sub StwInformation
(
)

local
{
  tItem          : int;   // Cte-Item
  tLineFirst     : int;   // Suchbereich: ab Zeile
  tLineLast      : int;   // Suchbereich: bis Zeile
  tCaseSensitive : logic; // Groß-/Kleinschreibung beachten
}

{
  // Item lesen...
  tItem # CteRead(...)
    
  // Informationen aus Custom-Eigenschaft lesen
  tLineFirst # CNVIA(AfStrGet(tItem->spCustom, ',', 1));
  tLineLast # CNVIA(AfStrGet(tItem->spCustom, ',', 2));
  tCaseSensitive # CNVLI(CNVIA(AfStrGet(tItem->spCustom, ',', 3)));
    
  // Informationen verarbeiten...
  ...
}

Wird ein ungültiger Deskriptor übergeben, kommt es zu einem Laufzeitfehler!

Neben den allgemeinen Fehlerwerten können folgende Werte zurückgegeben werden:

Konstante	Wert	Bedeutung
_ErrOk	0	ok - kein Fehler aufgetreten
sAfErrItemLimit	-20015	Die maximale Anzahl an übertragbaren Elementen (ca. 5000) wurde überschritten
sAfErrNoRecAbm	-20026	Die in (int1) übergebene Arbeitsmappe existiert nicht

Für weitere CONZEPT 16-spezifische Rückgabewerte siehe die aktuelle CONZEPT 16-Hilfe.