AfAbmCreate

Aus ArcFlow Wiki
Version vom 16. Oktober 2024, 07:55 Uhr von Jens (Diskussion | Beiträge) (Stand 4.1.09)
(Unterschied) ← Nächstältere Version | Aktuelle Version (Unterschied) | Nächstjüngere Version → (Unterschied)
Zur Navigation springen Zur Suche springen
file:DE_Schriftzug.gif
 AfAbmCreate(int1, alpha2, alpha3, var int4[, date5[, int6[, int7[, int8[, int9]]]]]) : int

Ausführbar von der APIAusführbar von der ProgrammierschnittstelleAusführbar mit der Application Remote ControlAusführbar von der Script-API

Arbeitsmappe erstellen
int1 Nummer der Eltern-Arbeitsmappe
alpha2 Name der Arbeitsmappe
alpha3 Beschreibung der Arbeitsmappe
int4 Nummer der neuen Arbeitsmappe
date5 Abschlussvorgabe (optional)
int6 Mappen-Unterteilung (optional)
int7 Mappentyp (optional)
int8 Mappenfeldgruppe (optional)
int9 Id des Symbols der Arbeitsmappe (optional)
Resultat int Fehlerwert
Siehe

Verwandte Befehle, AfAbmDelete(), AfAbmEdit(), AfAbmCreateByTemplate(), AfAbmCreateByPath()

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. Die Angabe eines Abschlussdatums in (date5) ist optional.

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

Ü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

In (int8) kann optional die ID einer Mappenfeldgruppe übergeben werden.

Das Symbol der Arbeitsmappe kann verändert werden. Dazu muss die Id des neuen Symbols im Parameter (int9) übergeben werden.

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.

Bei der Verwendung mit der Application Remote Control werden die Parameter mit folgenden Namen übergeben:

/AbmParent Nummer der Eltern-Arbeitsmappe
/Name Name der Arbeitsmappe
/Descr Beschreibung der Arbeitsmappe
/AbschlDat Abschlussdatum
/Partition Mappenunterteilung
/AbmType Mappentyp
/AbmFldGrp Mappenfeldgruppe
/RsltPath Pfad und Name der externen Datei, in der das Ergebnis gespeichert wird.

Zum Beispiel:
/user=admin /password=troja /action=fnc /fnc=AfAbmCreate /AbmParent=600448 /Name=Rechnungen /Descr="Rechnungen des Kunden" /AbschlDat=0.0.0 /Partition=2 /AbmType=0 /AbmFldGrp=1 /RsltPath=c:\temp\AFAPIRES.TXT

In der Ergebnisdatei wird in der ersten Zeile die übergebene Anweisung geschrieben. In der zweiten Zeile wird der Rückgabewert der Funktion gespeichert. In der folgenden Zeile wird die Nummer der neuen Arbeitsmappe geschrieben.

Beispiel:

tAbmParent      # 0;     // Number of parent workfolder (root workfolder)
tAbmClosingDate # 0.0.0; // Workfolder is not closed
tAbmFieldGroup  # 2;     // Workfolder fieldgroup number
tAbmIcon        # 22;    // Symbol of the workfolder

tErr # AfAbmCreate(tAbmParent,'Name','Description',var tAbmNo, tAbmClosingDate, sAbmPartYearMonth, sAbmTypeNormal, tAbmFieldGroup, tAbmIcon);

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
sAfErrInvalidAbmIcon -20057 Das in (int9) angegebene Symbol existiert nicht

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