AFapi.AbmLstGet

AFapi.AbmLstGet(int1, array2, logic3) : int
Liste der Arbeitsmappen
int1 Arbeitsmappennummer der Elternmappe array2 Deskriptor eines Arrays logic3 alle untergeordneten Mappen laden Resultat int Fehlerwert Siehe Verwandte Befehle, AFarray.GetItem(), AFitem.GetName(), AFitem.GetCustom()

Mit der Funktion lassen sich alle Arbeitsmappen ermitteln, die sich in der übergebenen Arbeitsmappe befinden. Die Eltern-Arbeitsmappennummer wird in dem Parameter (int1) übergeben.

Standardmässig werden nur die Arbeitsmappen zurückgegeben, die sich direkt in der Eltern-Arbeitsmappe befinden. Sollen alle Mappen aus allen untergeordneten Ebenen zurückgegeben werden, kann dies durch das Setzen des Parameters (logic3) auf true erreicht werden.

Im Parameter (array2) muss der Deskriptor eines Arrays übergeben werden, das vor dem Aufruf der Funktion angelegt wurde.

Nach dem Aufruf der Funktion ist für jede untergeordnete Mappe ein Objekt in dem Array vorhanden. Die Arbeitsmappen-Id, den Namen, sowie die Beschreibung können über die Befehle AFarray.GetItem(), AFitem.GetName(), AFitem.GetCustom() ermittelt werden.

Es werden nicht mehr als 5000 Arbeitsmappen übergeben. Sollten mehr Arbeitsmappen vorhanden sein, müssen die jeweils untergeordneten Mappen einer Arbeistmappe ausgelesen werden.

Die Informationen werden dabei je nach Option unterschiedlich abgelegt:

• (logic3) = FALSE (Standard)

  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.

• (logic3) = TRUE

  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.

Wird ein ungültiger Deskriptor in (int2) ü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.