AfArcNonAllocatedLstGet

Aus ArcFlow Wiki
Zur Navigation springen Zur Suche springen
Diese Seite enthält Bearbeitungen, die nicht zum Übersetzen freigegeben sind.
 AfArcNonAllocatedLstGet(int1) : int

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

Archive, die keiner Arbeitsmappe zugewiesen sind, ermitteln
int1 Deskriptor einer leeren CTE-Liste
Resultat int Fehlerwert
Siehe

Verwandte Befehle

Mit der Funktion lassen sich alle Archive ermitteln, die keiner Arbeitsmappe zugeordnet sind. Im Parameter (int1) 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 und in der Eigenschaft "Custom" die Beschreibung des Archivs ausgelesen werden.

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

Beispiel:

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

{
  ...
  // Read all non-allocated archives
  tArcList # AfCteOpen(_CteList);
  if (tArcList > 0)
  {
    tErr # AfArcNonAllocatedLstGet(tArcList);
    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()
    ...
  }
  ...
}

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
sAfErrNoRights -20029 Der Benutzer hat nicht das Recht die nicht zugewiesenen Archive zu lesen.

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