AfAbmArcLstGet: Unterschied zwischen den Versionen
Jens (Diskussion | Beiträge) K Jens verschob die Seite AFAbmArcLstGet nach AfAbmArcLstGet, ohne dabei eine Weiterleitung anzulegen |
Jens (Diskussion | Beiträge) K Stand 4.1.09 |
||
| Zeile 6: | Zeile 6: | ||
</tr> | </tr> | ||
<tr class="ProcSyntax"> | <tr class="ProcSyntax"> | ||
<td class="title"> | <td class="title"> AfAbmArcLstGet(int1, int2[, logic3]) : int</td> | ||
<td class="platforms"> | <td class="platforms"> | ||
[[file:DE_SymbolAPI.gif|alt=Ausführbar von der API|link=Befehle der Schnittstellen]][[file:DE_SymbolDLL.gif|alt=Ausführbar von der Programmierschnittstelle|link=Befehle der Schnittstellen]][[file:DE_SymbolARC.gif|alt=Ausführbar mit der Application Remote Control|link=Befehle der Schnittstellen]][[file:DE_SymbolScriptAPI.gif|alt=Ausführbar von der Script-API|link=Befehle der Schnittstellen]] | [[file:DE_SymbolAPI.gif|alt=Ausführbar von der API|link=Befehle der Schnittstellen]][[file:DE_SymbolDLL.gif|alt=Ausführbar von der Programmierschnittstelle|link=Befehle der Schnittstellen]][[file:DE_SymbolARC.gif|alt=Ausführbar mit der Application Remote Control|link=Befehle der Schnittstellen]][[file:DE_SymbolScriptAPI.gif|alt=Ausführbar von der Script-API|link=Befehle der Schnittstellen]] | ||
| Zeile 52: | Zeile 52: | ||
<p><p>Mit der Funktion lassen sich alle Archive ermitteln, die sich in einer übergebenen Arbeitsmappe befinden. Die Arbeitsmappen-Nummer wird über den Parameter (int1) übermittelt.</p> | <p><p>Mit der Funktion lassen sich alle Archive ermitteln, die sich in einer übergebenen Arbeitsmappe befinden. Die Arbeitsmappen-Nummer wird über den Parameter (int1) übermittelt.</p> | ||
<p>Im zweiten Parameter muss der Deskriptor einer leeren Cte-Liste übergeben werden, die vor dem Aufruf der Funktion über den Befehl [[ | <p>Im zweiten Parameter muss der Deskriptor einer leeren Cte-Liste übergeben werden, die vor dem Aufruf der Funktion über den Befehl [[AfCteOpen#|AfCteOpen()]] angelegt wurde.</p> | ||
<p>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) <font class=source>true</font> übergeben, steht in der Eigenschaft "Custom" zusätzlich die Beschreibung des Archivs.</p> | <p>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) <font class=source>true</font> übergeben, steht in der Eigenschaft "Custom" zusätzlich die Beschreibung des Archivs.</p> | ||
| Zeile 78: | Zeile 78: | ||
<p>Zum Beispiel:<br> | <p>Zum Beispiel:<br> | ||
<font class=source>/user=admin /password=troja /action=fnc /fnc= | <font class=source>/user=admin /password=troja /action=fnc /fnc=AfAbmArcLstGet /AbmNr=600448 /ExtendedPara=1 /RsltPath=c:\temp\AFAPIRES.TXT</font></p> | ||
<p>In der Ergebnisdatei wird in der ersten Zeile die übergebene Anweisung | <p>In der Ergebnisdatei wird in der ersten Zeile die übergebene Anweisung | ||
| Zeile 104: | Zeile 104: | ||
if (tArcList > 0) | if (tArcList > 0) | ||
{ | { | ||
tErr # | tErr # AfAbmArcLstGet(tAbmNo,tArcList,true); | ||
if (tErr = _ErrOk) | if (tErr = _ErrOk) | ||
{ | { | ||
| Zeile 118: | Zeile 118: | ||
else | else | ||
{ | { | ||
// Error handling | // Error handling AfAbmArcLstGet() | ||
... | ... | ||
} | } | ||
tArcList-> | tArcList->AfCteCloseAll(); | ||
} | } | ||
else | else | ||
Aktuelle Version vom 16. Oktober 2024, 07:49 Uhr
 |
|||||||||||||||||||||
| AfAbmArcLstGet(int1, int2[, logic3]) : int |
|
||||||||||||||||||||
| Archive in einer Arbeitsmappe ermitteln | |||||||||||||||||||||
|
|||||||||||||||||||||
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. |
Zum Beispiel:
/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.
Beispiel:
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()
...
}
...
}
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.
