AfArcFileShowByScript
Mit dieser Funktion wird in ArFlow eine bestimmte Archivdatei angezeigt. Das Archiv wird über das in (alpha1) angegebene Skript bestimmt. Dem Skript können drei weitere Parameter (alpha2) bis (alpha4) übergeben werden.
Die Funktion kann nur mit der Application Remote Control verwendet werden. Die Parameter werden mit folgenden Namen übergeben:
/script | Name des Skripts |
/doctype | Dokumenttyp (gAfRmtCtrlDocType) |
/docnr | Dokumentnummer (gAfRmtCtrlDocNo) |
/docid | Dokument-Id (gAfRmtCtrlId) |
/RsltPath | Pfad und Name der externen Datei, in der das Ergebnis gespeichert wird. |
Zum Beispiel:
/user=admin /password=troja /action=open_dialog /fnc=AFArcFileShowByScript /script=ShowArcFile /doctype= /docnr= /docid= /RsltPath=c:\temp\AFAPIRES.TXT
Die übergebenen Werte in doctype, docnr und docid können im Skript über die Variablen gAfRmtCtrlDocType, gAfRmtCtrlDocNo und gAfRmtCtrlId ausgelesen werden.
Um ein Dokument anzuzeigen, muss innerhalb des Skripts die Variablen gAfArcNr und gAfArcFileNr gesetzt werden. Ist das Archiv mehreren Arbeitsmappen zugewiesen, kann zusätzlich die Arbeitsmappe in gAfAbmId definiert werden. Existiert das angegebene Archiv nicht, wird auf das Archiv mit der nächst höheren Archivnummer positioniert, es erfolgt aber keine Anzeige der Anhangdatei.
Ist die Variable gAfArcNr leer und die Variable gAfAbmId mit einer gültigen Arbeitsmappenid gefüllt, wird auf die entsprechende Arbeitsmappe positioniert.
Beispiel:
Das Skript wird mit folgenden Parametern aufgerufen:
/user=admin /password=troja /action=open_dialog /fnc=AfArcFileShowByScript /script=ShowArcFile /doctype=4321 /docnr=2017.0000123 /docid=1 /RsltPath=c:\temp\AFAPIRES.TXT
// Display of attachment file 1 of archive 2017.0000123 gAfArcNr # gAfRmtCtrlDocNo; gAfArcFileNr # gAfRmtDocId; gAfAbmId # 0; gAfAbmParentId # 0; return(true); // Positioning at the archive gAfArcNr # gAFRmtCtrlDocNo; gAfArcFileNr # 0; gAfAbmId # 0; gAfAbmParentId # 0; return(true); // Positioning at the workfolder gAfArcNr # 0; gAfArcFileNr # 0; gAfAbmId # gAfRmtCtrlDocType; gAfAbmParentId # 0; return(true);
In der Ergebnisdatei wird in der ersten Zeile die übergebene Anweisung geschrieben. In der zweiten Zeile wird der Rückgabewert der Funktion gespeichert.
Neben den allgemeinen Fehlerwerten können folgende Werte zurückgegeben werden:
Konstante | Wert | Bedeutung |
_ErrOk | 0 | ok - kein Fehler aufgetreten |
sAfErrArcFileNotExists | -20031 | Die Anhangdatei ist nicht vorhanden. |
Für weitere CONZEPT 16-spezifische Rückgabewerte siehe die aktuelle CONZEPT 16-Hilfe.