AfAbmRead

Aus ArcFlow Wiki
Version vom 15. Oktober 2024, 13:25 Uhr von Jens (Diskussion | Beiträge) (Jens verschob die Seite AFAbmRead nach AfAbmRead)
Zur Navigation springen Zur Suche springen
 AFAbmRead(int1) : int

Ausführbar von der APINicht ausführbar von der Programmierschnittstelle (DLL)Ausführbar mit der Application Remote ControlAusführbar von der Script-API

Arbeitsmappeninformation lesen
int1 Nummer der Arbeitsmappe
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
gAfAbmTemplateId int Id der Vorlagemappe
gAfAbmFldGrpId int Id der Mappenfeldgruppe
gAfAbmIcon int Id des Symbols der Arbeitsmappe
Resultat int Fehlerwert
Siehe

Verwandte Befehle, AFAbmReadByName()

Mit der Funktion lassen sich die Informationen der in (int1) übergebenen Arbeitsmappe lesen. Bei erfolgreicher Ausführung steht das Ergebnis in den angegebenen Feldpuffern.

Der Wert in gAfAbmPartitioning kann dabei mit folgenden Konstanten verglichen 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
sAfAbmPartYearMonthDay 3 virtuelle Jahres-, Monats- und Tages-Unterteilung unter der Arbeitsmappe
sAfAbmPartScript 4 virtuelle Unterteilung über ein Skript

Der Typ der Arbeitsmappe kann mit folgenden Werten verglichen werden:

Konstante Wert Bedeutung
sAfAbmTypeNormal 0 normale Arbeitsmappe
sAfAbmTypeTemplate 1 Vorlagemappe

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:

/AbmNr Nummer der Arbeitsmappe
/Parent ID der übergeordneten Arbeitsmappe
/Option Optionen (siehe Text)
/RsltPath Pfad und Name der externen Datei, in der das Ergebnis gespeichert wird.

Zum Beispiel:
/user=admin /password=troja /action=fnc /fnc=AFAbmRead /AbmNr=600452 /Parent=600448 /Option=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 den folgenden Zeilen wird die Nummer der Arbeitsmappe, der Name der Arbeitsmappe, die Nummer der Elternmappe, Beschreibung, Abschlussvorgabe, die Mappenunterteilung und der Mappentyp gespeichert.

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.