AfArcDelete: 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.13 Beispiel geändert, Helptip Ausführung angepasst
 
(3 dazwischenliegende Versionen von 2 Benutzern werden nicht angezeigt)
Zeile 6: Zeile 6:
   </tr>
   </tr>
   <tr class="ProcSyntax">
   <tr class="ProcSyntax">
     <td class="title">&nbsp;AFArcDelete(alpha1, var int2[, logic3]) : int</td>
     <td class="title">&nbsp;AfArcDelete(alpha1, var int2[, logic3]) : 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 46: Zeile 46:
   <td width="85%" class=Right colspan="3">
   <td width="85%" class=Right colspan="3">
[[:Category:Befehle für Archive|Verwandte Befehle]],
[[:Category:Befehle für Archive|Verwandte Befehle]],
[[AFArcCreate#|AFArcCreate()]]
[[AfArcCreate#|AfArcCreate()]]
   </td>
   </td>
</tr>
</tr>
Zeile 56: Zeile 56:
</table>
</table>
<div class="BigLang">
<div class="BigLang">
<p>Die Funktion löscht das übergebene Archiv mit allen zugehörige  
Die Funktion löscht das übergebene Archiv mit allen zugehörige Informationen und Anhangdateien{{Marker}}<!--Anhangdatei-->. Im ersten Schritt wird das Archiv zur Löschung markiert, der Index-Server{{Marker}}<!--IndexServer--> löscht dann das Archiv.
Informationen und  
Anhangdateien{{Marker}}<!--Anhangdatei-->.  
Im ersten Schritt wird das Archiv zur Löschung markiert, der  
Index-Server{{Marker}}<!--IndexServer--> löscht dann  
das Archiv.</p>


<p>Als Parameter (int2) muss eine ganzzahlige Variable angegeben werden.  
Als Parameter (int2) muss eine ganzzahlige Variable angegeben werden. In dieser Variablen steht nach dem Aufruf der Funktion im Fehlerfall der Datenbankbereich, in dem ein Fehler beim Löschen des Archives aufgetreten ist. Der Wert kann mit folgenden Konstanten verglichen werden:
  In dieser Variablen steht nach dem Aufruf der Funktion im Fehlerfall
  der Datenbankbereich, in dem ein Fehler beim Löschen des Archives  
  aufgetreten ist. Der Wert kann mit folgenden Konstanten verglichen  
  werden:</p>


<p><table class=lang>
<p><table class=lang>
Zeile 116: Zeile 107:
     <td valign=top><font class=source><center>30222</center></font>
     <td valign=top><font class=source><center>30222</center></font>
   </td>
   </td>
     <td valign=top>Archiv-Dokumentkopien (Die Konstante wird in einer der kommenden  
     <td valign=top>Archiv-Dokumentkopien (Die Konstante wird in einer der kommenden Versionen entfernt, statt dessen müssen die Konstanten <font class=source>sAfAreaPartArcDistr</font>, <font class=source>sAfAreaPartArcDistr2</font> und <font class=source>sAfAreaPartArcDistr3</font> verwendet werden.)</td>
  Versionen entfernt, statt dessen müssen die Konstanten
  <font class=source>sAfAreaPartArcDistr</font>,  
  <font class=source>sAfAreaPartArcDistr2</font> und  
  <font class=source>sAfAreaPartArcDistr3</font>
  verwendet werden.)
</td>
   </tr>
   </tr>
   <tr>
   <tr>
Zeile 207: Zeile 192:
</table></p>
</table></p>


<p>Über den optionalen Parameter (logic3) kann übergeben werden, dass  
Über den optionalen Parameter (logic3) kann übergeben werden, dass ein Archiv gelöscht wird, auch wenn beim Lesen der Anhangdateien{{Marker}}<!--Anhangdatei--> in den BLOB-Datenbanken Fehler auftreten (z.B. dass die Datei nicht gelöscht werden kann). '''Diese Option darf nicht immer angewendet werden!''' Sie darf nur in konkreten Einzelfällen genutzt werden, da sonst Dateireste in der Datenbank übrig bleiben können.  
ein Archiv gelöscht wird, auch wenn beim Lesen der  
Anhangdateien{{Marker}}<!--Anhangdatei-->
in den BLOB-Datenbanken Fehler auftreten (z.B. dass die Datei  
nicht gelöscht werden kann).  
'''Diese Option darf in keinem Fall immer angewendet werden!'''  
Sie darf nur in konkreten Einzelfällen genutzt werden, da sonst  
Dateireste in der Datenbank übrig bleiben können. </p>


<p>Bei Fragen kontaktieren Sie bitte den ArcFlow-Support.</p>
Bei Fragen kontaktieren Sie bitte den ArcFlow-Support.


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


<table class=lang>
<table class=lang>
Zeile 237: Zeile 213:
</table>
</table>


<p>Zum Beispiel: <br>
== Beispiele ==
<font class=source>/user=admin /password=troja /action=fnc /fnc=AFArcDelete /ArcNr=2008.0000012 /ErrIgnore=0 /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 beiden folgenden Zeilen wird die Fehlermeldung und die Dateinummer abgelegt.</p></p>
<pre class=source>
af_rmtcontrol.exe /user=admin /password=troja /action=fnc /fnc=AfArcDelete /ArcNr=2008.0000012 /ErrIgnore=0 /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. In den beiden folgenden Zeilen wird die Fehlermeldung und die Dateinummer abgelegt.
</tabber>


<p>
<p>
Zeile 290: Zeile 269:
</translate>
</translate>
[[Category:Befehle für Archive]]
[[Category:Befehle für Archive]]
[[Category:ListeAllerApiBefehleA]]

Aktuelle Version vom 9. Januar 2026, 09:42 Uhr

 AfArcDelete(alpha1, var int2[, logic3]) : int

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

Archiv löschen
alpha1 Nummer des Archives
int2 Bereich, in dem ein Fehler aufgetreten ist
logic3 Fehler beim Anhang ignorieren (optional)
Resultat int Fehlerwert
Siehe

Verwandte Befehle, AfArcCreate()

Die Funktion löscht das übergebene Archiv mit allen zugehörige Informationen und Anhangdateien. Im ersten Schritt wird das Archiv zur Löschung markiert, der Index-Server löscht dann das Archiv.

Als Parameter (int2) muss eine ganzzahlige Variable angegeben werden. In dieser Variablen steht nach dem Aufruf der Funktion im Fehlerfall der Datenbankbereich, in dem ein Fehler beim Löschen des Archives aufgetreten ist. Der Wert kann mit folgenden Konstanten verglichen werden:

Konstante Wert Bedeutung
sAfAreaPartArcTxt
30000
 		Archiv-Text
sAfAreaPartIdxJobs
30218
 		Indexserver-Jobs
sAfAreaPartArcSelState
30219
 		Archiv-IndexStatus
sAfAreaPartArcMain
30220
 		Archivdatensatz
sAfAreaPartArcDocCopy
30222
 		Archiv-Dokumentkopien (Die Konstante wird in einer der kommenden Versionen entfernt, statt dessen müssen die Konstanten sAfAreaPartArcDistr, sAfAreaPartArcDistr2 und sAfAreaPartArcDistr3 verwendet werden.)
sAfAreaPartArcDistr
30235
 		Archiv-Dokumentverteilung
sAfAreaPartArcDistr2
30236
 		Archiv-Dokumentverteilung (zugewiesene Sachbearbeiter)
sAfAreaPartArcDistr3
30237
 		Archiv-Dokumentverteilung (ausgewählte Dateien)
sAfAreaPartArcKeyWord
30223
 		Archiv-Stichwörter
sAfAreaPartArcDocCopy2
30224
 		Archiv-Dokumentkopie-Anhang
sAfAreaPartArcArcTypen
30225
 		Archiv-Archivtypen
sAfAreaPartArcFile
30226
 		Archiv-Anhangdateien
sAfAreaPartArcHistorie
30230
 		Archiv-Historie
sAfAreaPartArcWflDet
30240
 		Archiv-WorkFlow-Details
sAfAreaPartArcAbm
30261
 		Archiv-Arbeitsmappen

Über den optionalen Parameter (logic3) kann übergeben werden, dass ein Archiv gelöscht wird, auch wenn beim Lesen der Anhangdateien in den BLOB-Datenbanken Fehler auftreten (z.B. dass die Datei nicht gelöscht werden kann). Diese Option darf nicht immer angewendet werden! Sie darf nur in konkreten Einzelfällen genutzt werden, da sonst Dateireste in der Datenbank übrig bleiben können.

Bei Fragen kontaktieren Sie bitte den ArcFlow-Support.

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

/ArcNr Archivnummer des zu löschenden Archivs
/ErrIgnore Fehler beim Löschen des BLObs ignorieren
/RsltPath Pfad und Name der externen Datei, in der das Ergebnis gespeichert wird.

Beispiele

af_rmtcontrol.exe /user=admin /password=troja /action=fnc /fnc=AfArcDelete /ArcNr=2008.0000012 /ErrIgnore=0 /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 beiden folgenden Zeilen wird die Fehlermeldung und die Dateinummer abgelegt.

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

Konstante Wert Bedeutung
_ErrOk 0 ok - kein Fehler aufgetreten
_rLocked 1 Ein anderer Benutzer hat das Archiv zur Zeit gesperrt.
_rNoRec 5 Das zu löschende Archiv wurde nicht gefunden.
sAfErrNoRights -20029 Die Berechtigungen reichen nicht aus.

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

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