AFapi.AbmCreate

Aus ArcFlow Wiki
Version vom 6. November 2023, 13:20 Uhr von Jens (Diskussion | Beiträge) (Stand 4.1.08)
(Unterschied) ← Nächstältere Version | Aktuelle Version (Unterschied) | Nächstjüngere Version → (Unterschied)
Zur Navigation springen Zur Suche springen
 AFapi.AbmCreate(int1, alpha2, alpha3, int4[, date5[, int6[, int7[, int8]]]]) : int

Nicht ausführbar von der APIAusführbar von der ProgrammierschnittstelleNicht ausführbar mit der Application Remote ControlNicht ausführbar von der Script-API

Arbeitsmappe erstellen
Eingabeparameter int1 Nummer der Eltern-Arbeitsmappe
Eingabeparameter alpha2 Name der Arbeitsmappe
Eingabeparameter alpha3 Beschreibung der Arbeitsmappe
Eingabeparameter int4 Nummer der neuen Arbeitsmappe
Eingabeparameter date5 Abschlussvorgabe (optional)
Eingabeparameter int6 Mappen-Unterteilung (optional)
Eingabeparameter int7 Mappentyp (optional)
Resultat int Fehlerwert
Siehe

Verwandte Befehle

Die Funktion legt eine neue Arbeitsmappe mit dem in (alpha2) angegebenen Namen an. Sie wird als Untermappe der in (int1) übergebenen Mappe angelegt. Wird in (int1) 0 übergeben, dann wird die Arbeitsmappe in der obersten Ebene angelegt. Zusätzlich kann über (alpha3) eine kurze Beschreibung der Mappe übergeben werden.

In (int4) wird die Nummer der neu erzeugten Arbeitsmappe zurückgegeben.

Die Angabe eines Abschlussdatums in (date5) ist optional. Über den Parameter (int6) kann definiert werden, wie die Arbeitsmappe virtuell unterteilt werden soll. Unter der Arbeitsmappe können automatisch Jahresmappen und gegebenenfalls auch Monatsordner angezeigt werden, um die zugewiesenen Archive zu gliedern. Folgende Konstanten können übergeben 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 (int7) kann zudem optional der Arbeitsmappentyp definiert werden. Folgende Konstanten können übergeben werden:

Konstante Wert Bedeutung
sAFAbmTypeNormal 0 Normale Arbeitsmappe
sAFAbmTypeTemplate 1 Vorlagemappe

Ist in der übergebenen Elternmappe bereits eine Arbeitsmappe mit diesem Namen enthalten, wird Wert _rExists zurückgegeben. 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
_rExists 6 Die in (alpha2) übergebene Arbeitsmappe existiert bereits
sAfErrNoRecAbm -20026 Die in (int1) übergebene Arbeitsmappe existiert nicht
sAfErrNoRecAbmFldGrp -20038 Die in (int8) übergebene Mappenfeldgruppe existiert nicht
sAfErrInvalidAbmType -20041 Der in (int7) übergebene Mappentyp existiert nicht

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