AfAbmLstGetByTemplate

AfAbmLstGetByTemplate(int1, handle2) : int
Liste der Arbeitsmappen mit einer Vorlagemappe ermitteln
int1 Nummer der Vorlagemappe handle2 Deskriptor einer leeren Cte-Liste Resultat int Fehlerwert Siehe Verwandte Befehle, AfAbmLstGetByAbmFldLst(), AfAbmLstGetByAbmFld(), AfAbmLstGetByDescr

Mit der Funktion lassen sich alle Arbeitsmappen ermitteln, die die angegebenen Vorlagemappe (int1) besitzen. Es werden alle Arbeitsmappen durchsucht. Im Parameter (handle2) 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 Mappe ein Objekt in der Cte-Liste vorhanden. Die Objekte können geladen werden und über die Eigenschaften "Name", "Id" und "Custom" können die Mappen-Informationen ausgelesen werden.

Name	In der Eigenschaft "Name" wird die Nummer der Arbeitsmappe gespeichert
Id	In der Eigenschaft kann die Unterteilung der Mappe ermittelt werden
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.

Beispiel:

Name = '14', Custom = '-Workfolder' - Die Arbeitsmappe 14 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
sAbmPartNone	0	keine virtuelle Unterteilung
sAbmPartYear	1	virtuelle Jahres-Unterteilung unter der Arbeitsmappe
sAbmPartYearMonth	2	virtuelle Jahres- und Monats-Unterteilung unter der Arbeitsmappe
sAbmPartYearMonthDay	3	virtuelle Jahres-, Monats- und Tages-Unterteilung unter der Arbeitsmappe

Wird ein ungültiger Deskriptor in (handle2) übergeben, kommt es zu einem Laufzeitfehler.

Beispiel:

define
{
  sAbmTemplateCustomer : 2
}

local
{
  tCteList   : handle;
  tCteItem   : handle;
  tResult    : int;
  tAbmId     : int;
  tAbmName   : alpha(250);
}

...
tCteList # AfCteOpen(_CteList);
tResult # AfAbmLstGetByTemplate(sAbmTemplateCustomer, tCteList);
for tCteItem # tCteList->CteRead(_CteFirst);
loop tCteItem # tCteList->CteRead(_CteNext, tCteItem);
while (tCteItem > 0)
{
  tAbmId     # CnvIA(tCteItem->spName;
  tAbmName   # StrCut(tCteItem->spCustom,2,250);
  ...
}
tCteList->AfCteCloseAll();

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

Konstante	Wert	Bedeutung
_ErrOk	0	ok - kein Fehler aufgetreten
sAfErrNoRecAbm	-20026	Die in (int1) angegebene Arbeitsmappe ist nicht vorhanden.
sAfErrInvalidAbmType	-20041	Die in (int1) angegebene Arbeitsmappe ist keine Vorlagemappe.

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