AfArcSearchResLstGet

Aus ArcFlow Wiki
Version vom 11. November 2024, 13:33 Uhr von Jens (Diskussion | Beiträge) (Jens verschob die Seite AFArcSearchResLstGet nach AfArcSearchResLstGet, ohne dabei eine Weiterleitung anzulegen)
Zur Navigation springen Zur Suche springen
 AFArcSearchResLstGet(int1, int2, int3, int4) : int

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

Ergebnisliste der Archiv-Suche ermitteln
int1 Deskriptor der Ergebnismenge
int2 maximale Anzahl der Suchergebnisse
int3 Startpunkt für Rückgabe der Ergebnisse
int4 Deskriptor einer leeren Cte-Liste
Resultat int Fehlerwert
Siehe

Verwandte Befehle, AFArcSearchStart()

Nachdem eine Suche mit der Funktion AFArcSearchStart() durchgeführt wurde, kann mit dieser Funktion die Ergebnisliste ermittelt werden. Der Deskriptor der Suche, welcher bei der Funktion AFArcSearchStart() übergeben wurde, muss als Parameter (int1) übergeben werden.

Anschließend muss über den zweiten Parameter definiert werden, wie viele Ergebnisse maximal in die Liste eingelesen werden sollen. Falls alle Elemente eingelesen werden sollen, muss der Wert 0 übergeben werden. Es ist dabei zu beachten, dass es bei vielen gefundenen Archiven länger dauern kann, bis die Ergebnisliste ermittelt ist.

Über den Parameter (int3) wird festgelegt, ab welchem Element die Liste aufgebaut wird. Diese Eingabe ist von Bedeutung, wenn zuvor eine Obergrenze an maximalen Suchergebnissen angegeben wurde. Dadurch besteht die Möglichkeit, die Suchergebnisse blockweise anzuzeigen, also beispielsweise in 20er-Schritten.

Im vierten 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 gefundenem Element ein Objekt in der Cte-Liste vorhanden. Die Objekte können geladen werden und über die Eigenschaft "Name" kann die Archiv-Nummer ausgelesen werden.

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

Wurde die Funktion AFArcSearchStart() zuvor nicht ausgeführt oder kam es bei der Ausführung zu einem Fehler, wird der Wert sAfErrNoResLstGet von der Funktion zurück geliefert.

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.

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