AfArcFileLstGet

AfArcFileLstGet(alpha1, int2[, logic3]) : int
Liste der Anhangdateien zu einem Archiv
alpha1 Nummer des Archives int2 Deskriptor einer leeren Cte-Liste logic3 Erweiterte Informationen Resultat int Fehlerwert Siehe Verwandte Befehle, AfArcFileVerLstGet()

Mit der Funktion lassen sich alle Anhangdateien des in (alpha1) übergebenen Archivs ermitteln. Im zweiten Parameter muss der Deskriptor einer leeren Cte-Liste übergeben werden, die vor dem Aufruf der Funktion über den Befehl AfCteOpen() angelegt wurde.

Nach dem Aufruf der Funktion ist pro Anhangdatei ein Objekt in der Cte-Liste vorhanden. Die Objekte können geladen werden und über die Eigenschaft "Name" die Anhang-Nummer und über die Eigenschaft "Custom" der Original-Dateiname ausgelesen werden. Wurde in (logic3) true übergeben, befindet sich in der "Custom"-Eigenschaft neben dem Dateinamen noch die Größe der Originaldatei (in Byte) sowie das Datum (im Format yyyy-mm-dd) und die Uhrzeit der letzten Änderung. Die Informationen sind durch das Zeichen # getrennt.

Wird ein ungültiger Deskriptor übergeben, kommt es zu einem Laufzeitfehler.

Beispiele

ScriptAPIArcFlowRemoteControlArcFlow.NEXT

// leere Liste anlegen
tArcFileList # AfCteOpen(_CteList);
if (tArcFileList <= 0)
{
  // Error handling for AfCteOpen()
  AfAddLogEntry(_LogError, 'Archivanhangliste konnte nicht angelegt werden.', CnvAI(tArcFileList));
  return(_ErrGeneric);
}

tResult # AFArcFileLstGet(tArcNo,tArcFileList);
if (tResult != _ErrOk)
{
  // Error handling AFAbmArcLstGet()
  AfAddLogEntry(_LogError, 'Fehler beim Ermitteln der Anhangdateiliste.', CnvAI(tResult), tArcNo);
  tArcFileList->AFCteCloseAll();
  return(tResult);
}
  
// Alle Anhangdateien durchsuchen
for tArcFileItem # tArcFileList->CteRead(_CteFirst);
loop tArcFileItem # tArcFileList->CteRead(_CteNext,tArcFileItem);
while (tArcFileItem > 0)
{
  // Anhangdatei lesen
  tResult # AfArcFileRead(tArcNo, CnvIA(tArcFileItem->spName));
  ...
}
return(_ErrOk);

af_rmtcontrol.exe /user=admin /password=troja /action=fnc /fnc=AFArcFileLstGet /ArcNr=2008.0000012 /ExtendedPara=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 werden je Zeile der Name einer Anhangdatei geschrieben. Werden die erweiterten Daten ermittelt, stehen die zusätzlichen Informationen in der gleichen Zeile durch # getrennt.

af.next.AfArcFileLstGet('2024.0001234', false).then(result => {
  if (result.code == af.next.constants.AfErrOk) {
    result.returnValues.arcFileList.forEach(arcFileItem => {
      console.log(arcFileItem.afArcFileName);
    }
  }
});

Ausgabe:

afArcFileCheckoutUser: ""
afArcFileDescr: ""
afArcFileExternId: ""
afArcFileExternType: ""
afArcFileModeEffect: 0
afArcFileName: "Neues Textdokument.zip"
afArcFileNr: 1
afArcFileSizeDba: 2048
afArcFileSizeOrg: 156
afArcFileState: 0
afArcFileType: "ZIP"

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

/ArcNr	Nummer des Archivs
/ExtendedPara	Erweiterte Daten ermitteln
/RsltPath	Pfad und Name der externen Datei, in der das Ergebnis gespeichert wird.

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

Konstante	Wert	Bedeutung
_ErrOk	0	ok - kein Fehler aufgetreten
_rNoRec	5	Es existiert kein Archiv mit der in (alpha1) angegebenen Nummer
sAfErrItemLimit	-20015	Die maximale Anzahl an übertragbaren Elementen (ca. 5000) wurde überschritten
sAfErrNoRights	-20029	Die Berechtigungen reichen nicht aus

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