AfAbmReadByDescr
![]() |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
AfAbmReadByDescr(alpha1, int2, int3) : int | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
Arbeitsmappe über Beschreibung lesen | |||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
Mit der Funktion kann eine Arbeitsmappe über ihre Beschreibung gelesen werden.
Die Beschreibung der Arbeitsmappe muss im Parameter (alpha1) übergeben werden. Über den zweiten Parameter wird die ID der Arbeitsmappe definiert, in der nach der übergebenen Beschreibung gesucht werden soll.
Als Optionen (int3) muss eine der folgenden Konstanten übergeben werden:
Konstante | Wert | Bedeutung |
sAfAbmSearchParent | Es wird nur in der in (int2) übergebenen Mappe gesucht. | |
sAfAbmSearchUnique | Es werden alle Arbeitsmappen durchsucht. Der erste Treffer wird zurückgegeben. |
Nach der erfolgreichen Ausführung der Anweisung stehen in den Feldpuffern die Informationen zu der gefundenen Arbeitsmappe.
In dem Feldpuffer gAfAbmPartitioning wird die Mappen-Unterteilung der Arbeitsmappe zurück gegeben. Der Wert kann mit folgenden Konstanten verglichen werden:
Konstante | Wert | Bedeutung |
sAfAbmPartNone | keine virtuelle Unterteilung | |
sAfAbmPartYear | virtuelle Jahres-Unterteilung unter der Arbeitsmappe | |
sAfAbmPartYearMonth | virtuelle Jahres- und Montats-Unterteilung unter der Arbeitsmappe | |
sAfAbmPartYearMonthDay | virtuelle Jahres-, Monats- und Tages-Unterteilung unter der Arbeitsmappe | |
sAfAbmPartScript | virtuelle Unterteilung über ein Skript |
gAfAbmType enthält den Arbeitsmappentyp. Der Wert kann mit folgende Konstanten verglichen werden:
Konstante | Wert | Bedeutung |
sAfAbmTypeNormal | Normale Arbeitsmappe | |
sAfAbmTypeTemplate | Vorlagemappe |
In gAfAbmCloseDate ist das Abschlussdatum der Mappe enthalten. Hat die Mappe kein Abschlussdatum wird ein leeres Datum (0.0.0) zurückgegeben.
Ist keine Arbeitsmappe mit der übergebenen Beschreibung vorhanden, wird der Wert der Konstanten sAfErrNoRecAbm zurückgeliefert. In den Feldpuffern stehen nach Aufruf der Funktion die Werte der nächsten gelesenen Arbeitsmappe.
Bei erfolgreicher Durchführung der Funktion wird der Wert _ErrOk zurückgegeben.
Neben den allgemeinen Fehlerwerten können folgende Werte zurückgegeben werden:
Konstante | Wert | Bedeutung |
_ErrOk | 0 | Kein Fehler. Die globalen Felder enthalten die Werte der gefundenen Arbeitsmappe. |
sAfErrInvalidArgValue | -20013 | In (int3) wurde ein ungültiger Parameter übergeben. |
sAfErrNoRecAbm | -20026 | Keine Arbeitsmappe mit der Beschreibung gefunden. |
sAfErrNoRights | -20029 | Berechtigungen nicht ausreichend. |
Für weitere CONZEPT 16-spezifische Rückgabewerte siehe die aktuelle CONZEPT 16-Hilfe.