|
|
| (Eine dazwischenliegende Version desselben Benutzers wird nicht angezeigt) |
| Zeile 6: |
Zeile 6: |
| </tr> | | </tr> |
| <tr class="ProcSyntax"> | | <tr class="ProcSyntax"> |
| <td class="title"> AFAbmLstGet(int1, handle2[, logic3[, logic4]]) : int</td> | | <td class="title"> AfAbmLstGet(int1, handle2[, logic3[, logic4]]) : int</td> |
| <td class="platforms"> | | <td class="platforms"> |
| [[file:DE_SymbolAPI.gif|alt=Ausführbar von der API|link=Befehle der Schnittstellen]][[file:DE_SymbolNoDLL.gif|alt=Nicht ausführbar von der Programmierschnittstelle (DLL)|link=Befehle der Schnittstellen]][[file:DE_SymbolNoARC.gif|alt=Nicht 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|Ausführbar von der API]][[file:DE_SymbolNoDLL.gif|alt=Nicht ausführbar von der Programmierschnittstelle (DLL)|link=Befehle der Schnittstellen|Nicht ausführbar von der Programmierschnittstelle (DLL)]][[file:DE_SymbolNoARC.gif|alt=Nicht ausführbar mit der Application Remote Control|link=Befehle der Schnittstellen|Nicht ausführbar mit der Application Remote Control]][[file:DE_SymbolScriptAPI.gif|alt=Ausführbar von der Script-API|link=Befehle der Schnittstellen|Ausführbar von der Script-API]] |
| </td> | | </td> |
| </tr> | | </tr> |
| Zeile 52: |
Zeile 52: |
| <td width="85%" class=Right colspan="3"> | | <td width="85%" class=Right colspan="3"> |
| [[:Category:Befehle für Arbeitsmappen|Verwandte Befehle]], | | [[:Category:Befehle für Arbeitsmappen|Verwandte Befehle]], |
| [[AFAbmLstGetByDescr#|AFAbmLstGetByDescr()]] | | [[AfAbmLstGetByDescr#|AfAbmLstGetByDescr()]] |
| </td> | | </td> |
| </tr> | | </tr> |
| Zeile 69: |
Zeile 69: |
| <p>Die Arbeitsmappen werden unsortiert zurückgegeben, soll die bei den [[Parameter Anzeige#|Parametern des Benutzers]] eingestellte Sortierung verwendet werden, muss in (logic4) <font class=source>true</font> angegeben werden.</p> | | <p>Die Arbeitsmappen werden unsortiert zurückgegeben, soll die bei den [[Parameter Anzeige#|Parametern des Benutzers]] eingestellte Sortierung verwendet werden, muss in (logic4) <font class=source>true</font> angegeben werden.</p> |
|
| |
|
| <p>Im Parameter (handle2) muss der Deskriptor einer leeren Cte-Liste übergeben werden, die vor dem Aufruf der Funktion über den Befehl [[AFCteOpen#|AfCteOpen()]] angelegt wurde.</p> | | <p>Im Parameter (handle2) 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 für jede untergeordnete Mappe ein Objekt in der Cte-Liste vorhanden. Die Objekte können geladen werden und über die Eigenschaften "Name", "Custom" und "ID" können die Mappen-Informationen ausgelesen werden.</p> | | <p>Nach dem Aufruf der Funktion ist für jede untergeordnete Mappe ein Objekt in der Cte-Liste vorhanden. Die Objekte können geladen werden und über die Eigenschaften "Name", "Custom" und "ID" können die Mappen-Informationen ausgelesen werden.</p> |
| Zeile 163: |
Zeile 163: |
| </table></p> | | </table></p> |
|
| |
|
| <p><b>Beispiele:</b>{{Marker}}
| | == Beispiele == |
| </p><p>
| |
| | |
| <p>Im folgenden Beispiel werden die Arbeitsmappen auf einer Ebene nach
| |
| einer Arbeitsmappe mit einem bestimmten Namen durchsucht: </p>
| |
|
| |
|
| | <tabber> |
| | |-|ScriptAPI= |
| | Im folgenden Beispiel werden die Arbeitsmappen auf einer Ebene nach einer Arbeitsmappe mit einem bestimmten Namen durchsucht: |
| <pre class=source> | | <pre class=source> |
| tCteList # AfCteOpen(_CteList); | | tCteList # AfCteOpen(_CteList); |
| Zeile 182: |
Zeile 181: |
| } | | } |
| </pre> | | </pre> |
| | Sollen alle untergeordneten Arbeitsmappen durchsucht werden, kann das Beispiel wie folgt abgewandelt werden: |
| | |
| | <pre class=source> |
| | // suchen nach Arbeitsmappen mit dem Namen "Projekte" -> ID zurückgeben |
| | tItem # CteRead(tCteList, _CteFirst | _CteSearch | _CteCustom, 0,'*#?Projekte'); |
| | while (tItem != 0) |
| | { |
| | // Arbeitsmappe gefunden |
| | ... |
| | |
| | // Nächste Arbeitsmappe suchen |
| | tItem # CteRead(tCteList, _CteNext | _CteSearch | _CteCustom, tItem,'*#?Projekte'); |
| | } |
| | |-|ArcFlowAPI= |
| | Im folgenden Beispiel werden die Arbeitsmappen auf einer Ebene nach einer Arbeitsmappe mit einem bestimmten Namen durchsucht: |
| | <pre class=source> |
| | tCteList # CteOpen(_CteList); |
|
| |
|
| <p>Sollen alle untergeordneten Arbeitsmappen durchsucht werden, kann das
| | // untergeordnete Arbeitsmappen ermitteln |
| Beispiel wie folgt abgewandelt werden:</p>
| | tErg # AF.API:AFAbmLstGet(tAbmParent,tCteList,false); |
|
| |
|
| | // suchen nach Arbeitsmappe mit Name "Projekte" -> ID zurückgeben |
| | tItem # CteRead(tCteList, _CteFirst | _CteSearch | _CteCustom, 0, '?Projekte'); |
| | if (tItem != 0) |
| | { |
| | tAbmId # tItem->spName; |
| | } |
| | </pre> |
| | Sollen alle untergeordneten Arbeitsmappen durchsucht werden, kann das Beispiel wie folgt abgewandelt werden: |
| <pre class=source> | | <pre class=source> |
| // suchen nach Arbeitsmappen mit dem Namen "Projekte" -> ID zurückgeben | | // suchen nach Arbeitsmappen mit dem Namen "Projekte" -> ID zurückgeben |
| Zeile 197: |
Zeile 221: |
| tItem # CteRead(tCteList, _CteNext | _CteSearch | _CteCustom, tItem,'*#?Projekte'); | | tItem # CteRead(tCteList, _CteNext | _CteSearch | _CteCustom, tItem,'*#?Projekte'); |
| } | | } |
| </pre></p> | | </tabber> |
|
| |
|
| <p>{{Info|Wird ein ungültiger Deskriptor in (int2) übergeben, kommt es zu einem Laufzeitfehler.}}</p> | | <p>{{Info|Wird ein ungültiger Deskriptor in (int2) übergeben, kommt es zu einem Laufzeitfehler.}}</p> |
Mit der Funktion lassen sich alle Arbeitsmappen ermitteln, die sich in der
übergebenen Arbeitsmappe befinden. Die Eltern-Arbeitsmappennummer wird in dem Parameter (int1) übergeben.
Standardmässig werden nur die Arbeitsmappen zurückgegeben, die sich direkt in der Eltern-Arbeitsmappe befinden. Sollen alle Mappen aus allen untergeordneten Ebenen zurückgegeben werden, kann dies durch das Setzen des Parameters (logic3) auf true erreicht werden.
Die Arbeitsmappen werden unsortiert zurückgegeben, soll die bei den Parametern des Benutzers eingestellte Sortierung verwendet werden, muss in (logic4) true angegeben werden.
Im Parameter (handle2) 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 für jede untergeordnete Mappe ein Objekt in der Cte-Liste vorhanden. Die Objekte können geladen werden und über die Eigenschaften "Name", "Custom" und "ID" können die Mappen-Informationen ausgelesen werden.
Es werden nicht mehr als 5000 Arbeitsmappen übergeben. Sollten mehr Arbeitsmappen vorhanden sein, müssen die jeweils untergeordneten Mappen einer Arbeistmappe ausgelesen werden.
Die Informationen werden dabei je nach Option unterschiedlich abgelegt:
Über die Eigenschaft "ID" des Items kann die Mappen-Unterteilung der Arbeitsmappe
abgefragt werden. Folgende Konstanten können zurückgegeben werden:
| Konstante
|
Wert
|
Bedeutung
|
| sAbmPartNone
|
0
|
keine virtuelle Unterteilung
|
| sAbmPartYear
|
1
|
virtuelle Jahres-Unterteilung unter der Arbeitsmappe
|
| sAbmPartYearMonth
|
2
|
virtuelle Jahres- und Monats-Unterteilung unter der Arbeitsmappe
|
Beispiele
Im folgenden Beispiel werden die Arbeitsmappen auf einer Ebene nach einer Arbeitsmappe mit einem bestimmten Namen durchsucht:
tCteList # AfCteOpen(_CteList);
// untergeordnete Arbeitsmappen ermitteln
tErg # AFAbmLstGet(tAbmParent,tCteList,false);
// suchen nach Arbeitsmappe mit Name "Projekte" -> ID zurückgeben
tItem # CteRead(tCteList, _CteFirst | _CteSearch | _CteCustom, 0, '?Projekte');
if (tItem != 0)
{
tAbmId # tItem->spName;
}
Sollen alle untergeordneten Arbeitsmappen durchsucht werden, kann das Beispiel wie folgt abgewandelt werden:
// suchen nach Arbeitsmappen mit dem Namen "Projekte" -> ID zurückgeben
tItem # CteRead(tCteList, _CteFirst | _CteSearch | _CteCustom, 0,'*#?Projekte');
while (tItem != 0)
{
// Arbeitsmappe gefunden
...
// Nächste Arbeitsmappe suchen
tItem # CteRead(tCteList, _CteNext | _CteSearch | _CteCustom, tItem,'*#?Projekte');
}
Im folgenden Beispiel werden die Arbeitsmappen auf einer Ebene nach einer Arbeitsmappe mit einem bestimmten Namen durchsucht:
tCteList # CteOpen(_CteList);
// untergeordnete Arbeitsmappen ermitteln
tErg # AF.API:AFAbmLstGet(tAbmParent,tCteList,false);
// suchen nach Arbeitsmappe mit Name "Projekte" -> ID zurückgeben
tItem # CteRead(tCteList, _CteFirst | _CteSearch | _CteCustom, 0, '?Projekte');
if (tItem != 0)
{
tAbmId # tItem->spName;
}
Sollen alle untergeordneten Arbeitsmappen durchsucht werden, kann das Beispiel wie folgt abgewandelt werden:
// suchen nach Arbeitsmappen mit dem Namen "Projekte" -> ID zurückgeben
tItem # CteRead(tCteList, _CteFirst | _CteSearch | _CteCustom, 0,'*#?Projekte');
while (tItem != 0)
{
// Arbeitsmappe gefunden
...
// Nächste Arbeitsmappe suchen
tItem # CteRead(tCteList, _CteNext | _CteSearch | _CteCustom, tItem,'*#?Projekte');
}
|
Wird ein ungültiger Deskriptor in (int2) übergeben, kommt es zu einem Laufzeitfehler.
|
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 in (int1) übergebene Arbeitsmappe existiert nicht |
Für weitere CONZEPT 16-spezifische Rückgabewerte siehe die
aktuelle CONZEPT 16-Hilfe.
