AfAbmReadByName

AfAbmReadByName(alpha1, int2, int3) : int
Arbeitsmappe über Namen lesen
alpha1 Arbeitsmappen-Name int2 ID der zu durchsuchenden Arbeitsmappe int3 Optionen 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(), AfAbmReadByPath(), AfAbmReadByDescr()

Mit der Funktion kann eine Arbeitsmappe über ihren Namen gelesen werden.

Der Name der Arbeitsmappe muss im Parameter (alpha1) übergeben werden. Über den zweiten Parameter wird die ID der Arbeitsmappe definiert, in der nach dem übergebenen Namen gesucht werden soll.

Als Optionen (int3) muss eine der folgenden Konstanten übergeben werden:

Konstante	Wert	Bedeutung
sAfAbmSearchParent	0	Es wird nur in der in (int2) übergebenen Mappe gesucht.
sAfAbmSearchSub	1	Es wird ebenfalls in allen Untermappen gesucht.
sAfAbmSearchUnique	4	Es werden alle Arbeitsmappen durchsucht.

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 dem übergebenen Namen vorhanden, wird der Wert der Konstanten sAfErrNoRecAbm zurückgeliefert. 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.

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

/Name	Name 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

ArcFlowRemoteControlArcFlow.NEXT

af_rmtcontrol.exe /user=admin /password=troja /action=fnc /fnc=AFAbmReadByName /Name=Rechnungen /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.AfAbmReadByName('Kunden', 0, af.next.constants.AFAbmSearchUnique).then(result => {
  if (result.code == af.next.constants.AFErrOk)
  {
    let abmId = result.returnValues.afAbmId;
    let abmName = result.returnValues.afAbmName;
    ...
  }
  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
sAfErrInvalidArgValue	-20013	Ungültiger Wert eines Parameters
sAfErrNoRecAbm	-20026	Die in (alpha1) übergebene Arbeitsmappe existiert nicht

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