AfAbmDelete: Unterschied zwischen den Versionen

Aus ArcFlow Wiki
Zur Navigation springen Zur Suche springen
← Zum vorherigen Versionsunterschied
K Stand 4.1.08 Buchstaben Kategorie entfernt
K Stand 4.1.18 Ausführung und Beispiel ergänzt
 
(3 dazwischenliegende Versionen desselben Benutzers werden 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]][[file:SymbolNext.gif|alt=Ausführbar von ArcFlow.NEXT|link=Befehle der Schnittstellen|Ausführbar von ArcFlow.NEXT]]
     </td>
     </td>
   </tr>
   </tr>
Zeile 40: Zeile 40:
   <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 51: Zeile 51:
</table>
</table>
<div class="BigLang">
<div class="BigLang">
<p><p>Die Funktion löscht die in (int1) übergebene Arbeitsmappe.</p>
Die Funktion löscht die in (int1) übergebene Arbeitsmappe.


<p>{{Info|Es werden automatische alle Untermappen der zu löschenden Arbeitsmappe gelöscht. Die in der Arbeitsmappe bzw. in den untergeordneten Arbeitsmappen enthaltenen Archive werden <b>nicht</b> gelöscht. Sind diese Archive keiner weiteren Arbeitsmappe zugeordnet, erscheinen sie in der Mappe "Nicht zugeordnete Archive".}}</p>
{{Info|Es werden automatische alle Untermappen der zu löschenden Arbeitsmappe gelöscht. Die in der Arbeitsmappe bzw. in den untergeordneten Arbeitsmappen enthaltenen Archive werden <b>nicht</b> gelöscht. Sind diese Archive keiner weiteren Arbeitsmappe zugeordnet, erscheinen sie in der Mappe "Nicht zugeordnete Archive".}}


<p>Im Parameter (int2) muss eine Variable von Typ <font class=source>int</font> angegeben werden. In dieser steht nach dem Aufruf der Funktion die Nummer der Elternarbeitsmappe.</p>
Im Parameter (int2) muss eine Variable von Typ <font class=source>int</font> angegeben werden. In dieser steht nach dem Aufruf der Funktion die Nummer der Elternarbeitsmappe.


<p>Bei der Verwendung mit der [[Application Remote Control (ARC)#|Application Remote Control]] werden die Parameter mit folgenden Namen übergeben:</p>
Bei der Verwendung mit der [[Application Remote Control (ARC)#|Application Remote Control]] werden die Parameter mit folgenden Namen übergeben:


<table class=lang>
<table class=lang>
Zeile 70: Zeile 70:
</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.
|-|ArcFlow.NEXT=
<pre class=source>
af.next.AfAbmDelete(600448).then(result => {
  if (result.code == af.next.constants.AFErrOk) {
    alert(result.returnValues.afAbmParentId);
    ...
  }
  else {
    af.next.AfGetErrorAlpha(result.code).then(resultError => {
      alert(result.code+' / '+result.webcode+' / '+resultError.returnValues.afError);
    });
  }
});
</pre>
</tabber>
 
Neben den [[Allgemeine Fehlercodes#|allgemeinen Fehlerwerten]] können folgende Werte zurückgegeben werden:


<p>
Neben den [[Allgemeine Fehlercodes#|allgemeinen Fehlerwerten]]
können folgende Werte zurückgegeben werden:
</p><p>
   <table class=lang>
   <table class=lang>
     <tr>
     <tr>
Zeile 90: Zeile 115:
       <td>ok - kein Fehler aufgetreten</td>
       <td>ok - kein Fehler aufgetreten</td>
     </tr>
     </tr>
     <tr class="ProcErrorItem">
     <tr class="ProcErrorItem">
       <td class=source valign=top>_rLocked</td>
       <td class=source valign=top>_rLocked</td>
Zeile 97: Zeile 120:
       <td>Die Arbeitsmappe ist von einem anderen Benutzer gesperrt</td>
       <td>Die Arbeitsmappe ist von einem anderen Benutzer gesperrt</td>
     </tr>
     </tr>
     <tr class="ProcErrorItem">
     <tr class="ProcErrorItem">
       <td class=source valign=top>_rNoRec</td>
       <td class=source valign=top>_rNoRec</td>
Zeile 104: Zeile 125:
       <td>Keine Arbeitsmappe mit dieser Nummer vorhanden</td>
       <td>Keine Arbeitsmappe mit dieser Nummer vorhanden</td>
     </tr>
     </tr>
  </table>


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


  </table>
</p><p>
Für weitere CONZEPT 16-spezifische Rückgabewerte siehe die
aktuelle CONZEPT 16-Hilfe.
</p>
</div>
</div>
</translate>
</translate>
[[Category:Befehle für Arbeitsmappen]]
[[Category:Befehle für Arbeitsmappen]]

Aktuelle Version vom 12. Mai 2026, 14:22 Uhr

 AfAbmDelete(int1, var int2) : int

Ausführbar von der APIAusführbar von der Programmierschnittstelle (DLL)Ausführbar mit der Application Remote ControlAusführbar von der Script-APIAusführbar von ArcFlow.NEXT

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.

af.next.AfAbmDelete(600448).then(result => {
  if (result.code == af.next.constants.AFErrOk) {
    alert(result.returnValues.afAbmParentId);
    ...
  }
  else {
    af.next.AfGetErrorAlpha(result.code).then(resultError => {
      alert(result.code+' / '+result.webcode+' / '+resultError.returnValues.afError);
    });
  }
});

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.

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