AfAbmArcLstGet

AfAbmArcLstGet(int1, int2[, logic3]) : int
Archive in einer Arbeitsmappe ermitteln
int1 Arbeitsmappen-Nummer int2 Deskriptor einer leeren CTE-Liste logic3 Erweiterte Daten ermitteln (optional) Resultat int Fehlerwert Siehe Verwandte Befehle

Mit der Funktion lassen sich alle Archive ermitteln, die sich in einer übergebenen Arbeitsmappe befinden. Die Arbeitsmappen-Nummer wird über den Parameter (int1) übermittelt.

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 Archiv ein Objekt in der Cte-Liste vorhanden. Die Objekte können geladen und über die Eigenschaft "Name" die Archiv-Nummer ausgelesen werden. Wurde im Parameter (logic3) true übergeben, steht in der Eigenschaft "Custom" zusätzlich die Beschreibung des Archivs.

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

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

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

Beispiele

ScriptAPIArcFlowAPIArcFlowRemoteControlArcFlow.NEXT

local
{
  tErr     : int;
  tAbmNo   : int;
  tArcList : handle;
  tArcItem : handle;
  tArcNo   : alpha(12);
  tArcDesc : alpha(250);
}

{
  ...
  // Read all archives in a workfolder
  tArcList # AfCteOpen(_CteList);
  if (tArcList > 0)
  {
    tErr # AfAbmArcLstGet(tAbmNo,tArcList,true);
    if (tErr = _ErrOk)
    {
      for tArcItem # tArcList->CteRead(_CteFirst);
      loop tArcItem # tArcList->CteRead(_CteNext,tArcItem);
      while (tArcItem > 0)
      {
        tArcNo   # tArcItem->spName;
        tArcDesc # tArcItem->spCustom;
        ...
      }
    }
    else
    {
      // Error handling AfAbmArcLstGet()
      ...
    }
    tArcList->AfCteCloseAll();
  }
  else
  {
    // Error handling for AfCteOpen()
    ...
  }
  ...
}

local
{
  tErr     : int;
  tAbmNo   : int;
  tArcList : handle;
  tArcItem : handle;
  tArcNo   : alpha(12);
  tArcDesc : alpha(250);
}

{
  ...
  // Read all archives in a workfolder
  tArcList # CteOpen(_CteList);
  if (tArcList > 0)
  {
    tErr # AF.API:AfAbmArcLstGet(tAbmNo,tArcList,true);
    if (tErr = _ErrOk)
    {
      for tArcItem # tArcList->CteRead(_CteFirst);
      loop tArcItem # tArcList->CteRead(_CteNext,tArcItem);
      while (tArcItem > 0)
      {
        tArcNo   # tArcItem->spName;
        tArcDesc # tArcItem->spCustom;
        ...
      }
    }
    else
    {
      // Error handling AfAbmArcLstGet()
      ...
    }
    tArcList->CteClear(true);
    tArcList->CteClose();
  }
  else
  {
    // Error handling for AfCteOpen()
    ...
  }
  ...
}

af_rmtcontrol.exe /user=admin /password=troja /action=fnc /fnc=AfAbmArcLstGet /AbmNr=600448 /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 die Archivnummern der gefundenen Archive aufgelistet. Werden die erweiterten Daten ermittelt, stehen die zusätzlichen Informationen in der gleichen Zeile durch # getrennt.

af.next.AfAbmArcLstGet(600448).then(result => {
  if (result.code == af.next.constants.AFErrOk) {
    result.returnValues.arcList.forEach(archive => {
      console.log(archive.afArcNr+' '+archive.afArcCaption);
    });
  }
  else {
    af.next.AfGetErrorAlpha(result.code).then(resultError => {
      alert(result.code+' / '+result.webcode+' / '+resultError.returnValues.afError);
    });
  }
});

Das Resultat nach erfolgreicher Ausführung der Anweisung befindet sich die Informationen zu den Archiven in einem Array in folgenden Variablen:

Variable	Bedeutung
...returnValues.arcList[0].afArcNr	Archiv Nummer
...returnValues.arcList[0].afArcDocDate	Dokumentdatum im Format "yyyy-mm-ddT00:00:00"
...returnValues.arcList[0].afArcScanDate	Archivdatum im Format "yyyy-mm-ddT00:00:00"
...returnValues.arcList[0].afArcStorageYears	Aufbewahrungsfrist in Jahren
...returnValues.arcList[0].afArcCreateModule	Erstellungsmodul
...returnValues.arcList[0].afArcCaption	Name des Archives
...returnValues.arcList[0].afArcLocation	Beschreibung des Archives
...returnValues.arcList[0].afArcFilesCnt	Anzahl der Anhangdateien
...returnValues.arcList[0].afArcScanFiles	Anzahl der Scandateien
...returnValues.arcList[0].afArcFileSize	Archivgröße (in KByte)
...returnValues.arcList[0].afArcColor	Farbe
...returnValues.arcList[0].afArcTypeString	Dateityper der Anhangdateien
...returnValues.arcList[0].afArcExternId	Externe Id
...returnValues.arcList[0].afArcExternType	Externer Typ

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

Konstante	Wert	Bedeutung
_ErrOk	0	ok - kein Fehler aufgetreten
sAfErrItemLimit	-20015	Die maximale Anzahl an übertragbaren Elementen (ca. 5000) wurde überschritten
sAfErrNoRecAbm	-20026	Die übergebene Arbeitsmappe existiert nicht

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