AfAbmRead

AfAbmRead(int1) : int
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(), AfAbmPropGet()

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.

Beispiele

ScriptAPIArcFlowAPIArcFlowRemoteControlArcFlow.NEXT

tResult # AfAbmRead(600452);
...
if (gAfAbmPartitioning = sAbmPartYearMonth)
{
  // Automatische Aufteilung in Jahr/Monat
  ...
}

tResult # AF.API:AfAbmRead(600452);
...
if (gAfAbmPartitioning = sAbmPartYearMonth)
{
  // Automatische Aufteilung in Jahr/Monat
  ...
}

af_rmtControl.exe /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.

af.next.AfAbmRead(600452).then(result => {
  if (result.code == af.next.constants.AFErrOk)
  {
    if (result.returnValues.afAbmPartitioning == af.next.constants.AFAbmPartYearMonth)
    {
      // Automatische Aufteilung in Jahr/Monat
      ...
    }
  }
  else
  {
    // Error handling
    alert('Result = ' + result.code + ' / ' + result.webcode);
  }
});

Das Resultat nach erfolgreicher Ausführung der Anweisung befindet sich in folgenden Variablen:

Variable	Bedeutung
...returnValues.afAbmId	Id
...returnValues.afAbmName	Name der Arbeitsmappe
...returnValues.afAbmParentId	Nummer der Eltern-Arbeitsmappe
...returnValues.afAbmDescr	Beschreibung
...returnValues.afAbmCloseDate	Abschlussvorgabe
...returnValues.afAbmPartitioning	Mappenunterteilung Der Wert kann mit den Konstanten af.next.constants.AFAbmPart... verglichen werden.
...returnValues.afAbmType	Typ der Arbeitsmappe Der Wert kann mit den Konstanten af.next.constants.AFAbmType... verglichen werden.
...returnValues.afAbmTemplateId	Id der Vorlagemappe
...returnValues.afAbmFldGrpId	Id der Mappenfeldgruppe
...returnValues.afAbmIcon	Id des Symbols der Arbeitsmappe

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.