AfAbmReadByDescr: Unterschied zwischen den Versionen

Aus ArcFlow Wiki
Zur Navigation springen Zur Suche springen
← Zum vorherigen Versionsunterschied
K Stand 4.1.08
K Stand 4.1.09
 
(2 dazwischenliegende Versionen desselben Benutzers werden nicht angezeigt)
Zeile 6: Zeile 6:
   </tr>
   </tr>
   <tr class="ProcSyntax">
   <tr class="ProcSyntax">
     <td class="title">&nbsp;AFAbmReadByDescr(alpha1, int2, int3) : int</td>
     <td class="title">&nbsp;AfAbmReadByDescr(alpha1, int2, int3) : int</td>
     <td class="platforms">
     <td class="platforms">
[[file:DE_SymbolAPI.gif|alt=Ausführbar von der API|link=Befehle der Schnittstellen]][[file:DE_SymbolNoDLL.gif|alt=Nicht ausführbar von der Programmierschnittstelle (DLL)|link=Befehle der Schnittstellen]][[file:DE_SymbolNoARC.gif|alt=Nicht ausführbar mit der Application Remote Control|link=Befehle der Schnittstellen]][[file:DE_SymbolScriptAPI.gif|alt=Ausführbar von der Script-API|link=Befehle der Schnittstellen]]
[[file:DE_SymbolAPI.gif|alt=Ausführbar von der API|link=Befehle der Schnittstellen]][[file:DE_SymbolNoDLL.gif|alt=Nicht ausführbar von der Programmierschnittstelle (DLL)|link=Befehle der Schnittstellen]][[file:DE_SymbolNoARC.gif|alt=Nicht ausführbar mit der Application Remote Control|link=Befehle der Schnittstellen]][[file:DE_SymbolScriptAPI.gif|alt=Ausführbar von der Script-API|link=Befehle der Schnittstellen]]
Zeile 104: Zeile 104:
   <td width="85%" class=Right colspan="3">
   <td width="85%" class=Right colspan="3">
[[:Category:Befehle für Arbeitsmappen|Verwandte Befehle]],
[[:Category:Befehle für Arbeitsmappen|Verwandte Befehle]],
[[AFAbmRead#|AFAbmRead()]],
[[AfAbmRead#|AfAbmRead()]],
[[AFAbmReadByName#|AFAbmReadByName()]],
[[AfAbmReadByName#|AfAbmReadByName()]],
[[AFAbmReadByPath#|AFAbmReadByPath()]]
[[AfAbmReadByPath#|AfAbmReadByPath()]]
   </td>
   </td>
</tr>
</tr>
Zeile 249: Zeile 249:
</translate>
</translate>
[[Category:Befehle für Arbeitsmappen]]
[[Category:Befehle für Arbeitsmappen]]
[[Category:ListeAllerApiBefehleA]]

Aktuelle Version vom 18. Oktober 2024, 09:25 Uhr

 AfAbmReadByDescr(alpha1, int2, int3) : int

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

Arbeitsmappe über Beschreibung lesen
alpha1 Arbeitsmappen-Beschreibung
int2 Id der Eltern-Arbeitsmappe
int3 Optionen
Feldpuffer
gAfAbmId int Id der Arbeitsmappe
gAfAbmParentId int Id der Elternarbeitsmappe
gAfAbmName alpha(250) Name der Arbeitsmappe
gAfAbmDescr alpha(250) Beschreibung der Arbeitsmappe
gAfAbmCloseDate date Abschlussdatum der Arbeitsmappe
gAfAbmPartitioning int Unterteilung der Arbeitsmappe
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, AfAbmRead(), AfAbmReadByName(), AfAbmReadByPath()

Mit der Funktion kann eine Arbeitsmappe über ihre Beschreibung gelesen werden.

Die Beschreibung der Arbeitsmappe muss im Parameter (alpha1) übergeben werden. Über den zweiten Parameter wird die ID der Arbeitsmappe definiert, in der nach der übergebenen Beschreibung 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.
sAfAbmSearchUnique
4
 Es werden alle Arbeitsmappen durchsucht. Der erste Treffer wird zurückgegeben.

Nach der erfolgreichen Ausführung der Anweisung stehen in den Feldpuffern die Informationen zu der gefundenen Arbeitsmappe.

In dem Feldpuffer gAfAbmPartitioning wird die Mappen-Unterteilung der Arbeitsmappe zurück gegeben. Der Wert kann 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 Montats-Unterteilung unter der Arbeitsmappe
sAfAbmPartYearMonthDay
3
 virtuelle Jahres-, Monats- und Tages-Unterteilung unter der Arbeitsmappe
sAfAbmPartScript
4
 virtuelle Unterteilung über ein Skript

gAfAbmType enthält den Arbeitsmappentyp. Der Wert kann mit folgende Konstanten verglichen werden:

Konstante Wert Bedeutung
sAfAbmTypeNormal
0
 Normale Arbeitsmappe
sAfAbmTypeTemplate
1
 Vorlagemappe

In gAfAbmCloseDate ist das Abschlussdatum der Mappe enthalten. Hat die Mappe kein Abschlussdatum wird ein leeres Datum (0.0.0) zurückgegeben.

Ist keine Arbeitsmappe mit der übergebenen Beschreibung 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.

Neben den allgemeinen Fehlerwerten können folgende Werte zurückgegeben werden:

Konstante Wert Bedeutung
_ErrOk 0 Kein Fehler. Die globalen Felder enthalten die Werte der gefundenen Arbeitsmappe.
sAfErrInvalidArgValue -20013 In (int3) wurde ein ungültiger Parameter übergeben.
sAfErrNoRecAbm -20026 Keine Arbeitsmappe mit der Beschreibung gefunden.
sAfErrNoRights -20029 Berechtigungen nicht ausreichend.

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

Abgerufen von „https://wiki.arcflow.net/index.php?title=AfAbmReadByDescr&oldid=6847“