AfAbmDelete: Unterschied zwischen den Versionen

Aus ArcFlow Wiki
Zur Navigation springen Zur Suche springen
K Jens verschob die Seite AFAbmDelete nach AfAbmDelete, ohne dabei eine Weiterleitung anzulegen
K Stand 4.1.13 Beispiel geändert, Helptip Ausführung angepasst
 
(Eine dazwischenliegende Version desselben Benutzers wird nicht angezeigt)
Zeile 6: Zeile 6:
   </tr>
   </tr>
   <tr class="ProcSyntax">
   <tr class="ProcSyntax">
     <td class="title">&nbsp;AFAbmDelete(int1, var int2) : int</td>
     <td class="title">&nbsp;AfAbmDelete(int1, var int2) : 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 40: Zeile 43:
   <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]],
[[AFAbmCreate#|AFAbmCreate()]],
[[AfAbmCreate#|AfAbmCreate()]],
[[AFAbmEdit#|AFAbmEdit()]]
[[AfAbmEdit#|AfAbmEdit()]]
   </td>
   </td>
</tr>
</tr>
Zeile 70: Zeile 73:
</table>
</table>


<p>Zum Beispiel:<br>
== Beispiele ==
<font class=source>/user=admin /password=troja /action=fnc /fnc=AFAbmDelete /AbmNr=600448 /RsltPath=c:\temp\AFAPIRES.TXT</font></p>


<p>In der Ergebnisdatei wird in der ersten Zeile die übergebene Anweisung geschrieben. In der zweiten Zeile wird der Rückgabewert der Funktion gespeichert. Anschließend wird die Nummer der Eltern-Arbeitsmappe geschrieben.</p></p>
<tabber>
|-|ScriptAPI=
<pre class=source>
tResult # AfAbmDelete(tAbmId);
</pre>
|-|ArcFlowAPI=
<pre class=source>
tResult # AF.API:AfAbmDelete(tAbmId);
</pre>
|-|ArcFlowRemoteControl=
<pre class=source>
af_rmtcontrol.exe /user=admin /password=troja /action=fnc /fnc=AfAbmDelete /AbmNr=600448 /RsltPath=c:\temp\AFAPIRES.TXT
</pre>
In der Ergebnisdatei wird in der ersten Zeile die übergebene Anweisung geschrieben. In der zweiten Zeile wird der Rückgabewert der Funktion gespeichert. Anschließend wird die Nummer der Eltern-Arbeitsmappe geschrieben.
</tabber>


<p>
<p>

Aktuelle Version vom 5. Dezember 2025, 15:24 Uhr

 AfAbmDelete(int1, var int2) : int

Ausführbar von der API Ausführbar von der Programmierschnittstelle (DLL) Ausführbar mit der Application Remote Control Ausführbar von der Script-API

Arbeitsmappe löschen
int1 Arbeitsmappennummer
int2 Nummer der Elternarbeitsmappe
Resultat int Fehlerwert
Siehe

Verwandte Befehle, AfAbmCreate(), AfAbmEdit()

Die Funktion löscht die in (int1) übergebene Arbeitsmappe.

Es werden automatische alle Untermappen der zu löschenden Arbeitsmappe gelöscht. Die in der Arbeitsmappe bzw. in den untergeordneten Arbeitsmappen enthaltenen Archive werden nicht gelöscht. Sind diese Archive keiner weiteren Arbeitsmappe zugeordnet, erscheinen sie in der Mappe "Nicht zugeordnete Archive".

Im Parameter (int2) muss eine Variable von Typ int angegeben werden. In dieser steht nach dem Aufruf der Funktion die Nummer der Elternarbeitsmappe.

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

/AbmNr Nummer der Arbeitsmappe
/RsltPath Pfad und Name der externen Datei, in der das Ergebnis gespeichert wird.

Beispiele

tResult # AfAbmDelete(tAbmId);

tResult # AF.API:AfAbmDelete(tAbmId);

af_rmtcontrol.exe /user=admin /password=troja /action=fnc /fnc=AfAbmDelete /AbmNr=600448 /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. Anschließend wird die Nummer der Eltern-Arbeitsmappe geschrieben.

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

Konstante Wert Bedeutung
_ErrOk 0 ok - kein Fehler aufgetreten
_rLocked 1 Die Arbeitsmappe ist von einem anderen Benutzer gesperrt
_rNoRec 5 Keine Arbeitsmappe mit dieser Nummer vorhanden

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