AfAbmLstGetByDescr

AfAbmLstGetByDescr(alpha1, int2, int3, int4) : int
Liste der Arbeitsmappen anhand der Beschreibung ermitteln
alpha1 Arbeitsmappen-Beschreibung der gesuchten Mappe int2 Arbeitsmappennummer der Elternmappe int3 Deskriptor einer leeren Cte-Liste int4 Optionen Resultat int Fehlerwert Siehe Verwandte Befehle, AfAbmLstGetByAbmFld(), AfAbmLstGetByAbmFldLst(), AfAbmLstGetByTemplate(), AfAbmLstGet()

Mit der Funktion lassen sich alle Arbeitsmappen ermitteln deren Beschreibung mit dem Text (alpha1) beginnt.

Die Suche beginnt in der Arbeitsmappe, die als Parameter (int2) übergeben wird. Je nach Option (int4) werden ebenfalls die Untermappen durchsucht:

Konstante (int4)	Wert	Beschreibung
sAfAbmSearchParent	0	Durchsucht nur die übergebene Mappe
sAfAbmSearchSub	1	Durchsucht die übergebene und alle untergeordneten Mappen

Im Parameter (int3) 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 für jede untergeordnete Mappe ein Objekt in der Cte-Liste vorhanden. Die Objekte können geladen werden und über die Eigenschaften "Name", "Custom" und "ID" können die Mappen-Informationen ausgelesen werden.

Die Informationen werden dabei je nach Option unterschiedlich abgelegt:

• (int4) = sAfAbmSearchParent

  Name	In der Eigenschaft "Name" wird die Nummer der Arbeitsmappe gespeichert
  Custom	In der Eigenschaft "Custom" wird ein Vorzeichen (+ oder -) gefolgt vom Namen der Arbeitsmappe gespeichert. Das Vorzeichen sagt aus, ob zu dieser Mappe weitere Untermappen vorhanden sind: "+", es sind Untermappen vorhanden, "-", es sind keine Untermappen vorhanden.

• (int4) = sAfAbmSearchSub

  Name	In der Eigenschaft "Name" wird die Nummer der Arbeitsmappe gespeichert
  Custom	In der Eigenschaft "Custom" wird die Nummer der Elternmappe, gefolgt von einem Trennzeichen "#", anschließend ein Vorzeichen (+ oder -) gefolgt vom Namen der Arbeitsmappe gespeichert. Das Vorzeichen sagt aus, ob zu dieser Mappe weitere Untermappen vorhanden sind: "+", es sind Untermappen vorhanden, "-", es sind keine Untermappen vorhanden.

  Beispiel:

  12#-Arbeitsmappe1 - Diese Arbeitsmappe ist eine Untermappe der Mappe mit der Nummer 12. Sie besitzt keine Untermappen.

Über die Eigenschaft "ID" des Items kann die Mappen-Unterteilung der Arbeitsmappe abgefragt werden. Folgende Konstanten können zurückgegeben werden:

Konstante	Wert	Bedeutung
sAfAbmPartNone	0	keine virtuelle Unterteilung
sAfAbmPartYear	1	virtuelle Jahres-Unterteilung unter der Arbeitsmappe
sAfAbmPartYearMonth	2	virtuelle Jahres- und Monats-Unterteilung unter der Arbeitsmappe
sAfAbmPartYearMonthDay	3	virtuelle Jahres-, Monats- und Tages-Unterteilung unter der Arbeitsmappe
sAfAbmPartScript	4	virtuelle Unterteilung über ein Skript

Wird ein ungültiger Deskriptor in (int3) ü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
sAfErrNoRecAbm	-20026	Die in (int2) übergebene Arbeitsmappe existiert nicht

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