AfAbmReadByExternId

Aus ArcFlow Wiki
Zur Navigation springen Zur Suche springen
Diese Seite enthält Bearbeitungen, die nicht zum Übersetzen freigegeben sind.
 AfAbmReadByExternId(int1) : int

Ausführbar von der APINicht ausführbar von der ProgrammierschnittstelleNicht ausführbar mit der Application Remote ControlAusführbar von der Script-API

Arbeitsmappe über externe Id lesen
int1 Externe Id
Feldpuffer
gAfAbmId int Id
gAfAbmName alpha(250) Name der Arbeitsmappe
gAfAbmParentId int Nummer der Eltern-Arbeitsmappe
gAfAbmDescr alpha(250) Beschreibung
gAfAbmCloseDate date Abschlussvorgabe
gAfAbmPartitioning int Mappenunterteilung
gAfAbmType int Typ der Arbeitsmappe
gAfAbmFldGrpId int Id der Mappenfeldgruppe
gAfAbmTemplateId int Id der Vorlagemappe
gAfAbmIcon int Id des Symbols der Arbeitsmappe
Resultat int Fehlerwert
Siehe

Verwandte Befehle, AfAbmRead(), AfAbmReadByName(), AfAbmReadByPath(), AfAbmReadByDescr()

Mit der Funktion kann eine Arbeitsmappe über ihre externe Id gelesen werden.

Die externe Id der Arbeitsmappe muss im Parameter (int1) übergeben werden.

Nach erfolgreicher Ausführung der Anweisung, stehen in den Feldpuffern die Werte der ermittelten Arbeitsmappe. Der Wert in gAfAbmPartitioning kann dabei mit folgenden Konstanten verglichen 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

In gAfAbmType wird der Arbeitsmappentyp zurückgegeben. Der Wert kann mit folgende Konstanten verglichen werden:

Konstante Wert Bedeutung
sAfAbmTypeNormal
0
Normale Arbeitsmappe
sAfAbmTypeTemplate
1
Vorlagemappe

Steht in gAfAbmCloseDate ein leeres Datum (0.0.0), hat die Arbeitsmappe kein Abschlussdatum.

Ist keine Arbeitsmappe mit der übergebenen Id vorhanden, wird der Wert der Konstanten sAfErrNoRecAbm zurück geliefert. 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 ok - kein Fehler aufgetreten
sAfErrNoRecAbm -20026 Die in (int1) übergebene Arbeitsmappe existiert nicht

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