|
|
| (3 dazwischenliegende Versionen desselben Benutzers werden nicht angezeigt) |
| Zeile 6: |
Zeile 6: |
| </tr> | | </tr> |
| <tr class="ProcSyntax"> | | <tr class="ProcSyntax"> |
| <td class="title"> AFAbmReadByName(alpha1, int2, int3) : int</td> | | <td class="title"> AfAbmReadByName(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_SymbolDLL.gif|alt=Ausführbar von der Programmierschnittstelle|link=Befehle der Schnittstellen]][[file:DE_SymbolARC.gif|alt=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|Ausführbar von der API]][[file:DE_SymbolDLL.gif|alt=Ausführbar von der Programmierschnittstelle (DLL)|link=Befehle der Schnittstellen|Ausführbar von der Programmierschnittstelle (DLL)]][[file:DE_SymbolARC.gif|alt=Ausführbar mit der Application Remote Control|link=Befehle der Schnittstellen|Ausführbar mit der Application Remote Control]][[file:DE_SymbolScriptAPI.gif|alt=Ausführbar von der Script-API|link=Befehle der Schnittstellen|Ausführbar von der Script-API]] |
| </td> | | </td> |
| </tr> | | </tr> |
| Zeile 103: |
Zeile 103: |
| <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()]], |
| [[AFAbmReadByPath#|AFAbmReadByPath()]], | | [[AfAbmReadByPath#|AfAbmReadByPath()]], |
| [[AFAbmReadByDescr#|AFAbmReadByDescr()]] | | [[AfAbmReadByDescr#|AfAbmReadByDescr()]] |
| </td> | | </td> |
| </tr> | | </tr> |
| Zeile 228: |
Zeile 228: |
| </table> | | </table> |
|
| |
|
| <p>Zum Beispiel: <br>
| | == Beispiel == |
| <font class=source>/user=admin /password=troja /action=fnc /fnc=AFAbmReadByName /Name=Rechnungen /Parent=600448 /Option=1 /RsltPath=c:\temp\AFAPIRES.TXT</font></p>
| |
|
| |
|
| <p>In der Ergebnisdatei wird in der ersten Zeile die übergebene Anweisung | | <tabber> |
| geschrieben. In der zweiten Zeile wird der Rückgabewert der Funktion gespeichert. In | | |-|ArcFlowRemoteControl= |
| den folgenden Zeilen wird die Nummer der Arbeitsmappe, der Name der Arbeitsmappe, die | | <pre class=source> |
| Nummer der Elternmappe, Beschreibung, Abschlussvorgabe, die Mappenunterteilung und | | af_rmtcontrol.exe /user=admin /password=troja /action=fnc /fnc=AFAbmReadByName /Name=Rechnungen /Parent=600448 /Option=1 /RsltPath=c:\temp\AFAPIRES.TXT |
| der Mappentyp gespeichert.</p></p> | | </pre> |
| | <p>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.</p> |
| | </tabber> |
|
| |
|
| <p> | | <p> |
| Zeile 276: |
Zeile 277: |
| </translate> | | </translate> |
| [[Category:Befehle für Arbeitsmappen]] | | [[Category:Befehle für Arbeitsmappen]] |
| [[Category:ListeAllerApiBefehleA]]
| |
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. |
Beispiel
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.
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 (int1) übergebene Arbeitsmappe existiert nicht |
Für weitere CONZEPT 16-spezifische Rückgabewerte siehe die
aktuelle CONZEPT 16-Hilfe.
