AfAbmTemplateLstGet

Aus ArcFlow Wiki
Zur Navigation springen Zur Suche springen
Diese Seite enthält Bearbeitungen, die nicht zum Übersetzen freigegeben sind.
 AfAbmTemplateLstGet(int1, int2[, logic3]) : 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

Liste der Vorlagemappen ausgehend von einer Elternmappe
int1 Vorlagemappen-Nummer der Elternmappe
int2 Deskriptor einer leeren Cte-Liste
logic3 Alle Untermappen laden? (optional)
Resultat int Fehlerwert
Siehe

Verwandte Befehle

Mit der Funktion lassen sich alle Vorlagemappen ermitteln, die sich in der übergebenen Vorlagemappe befinden. Die Eltern-Vorlagemappen-Nummer wird über den Parameter (int1) übermittelt.

Standardmässig werden nur die Vorlagemappen zurückgegeben, die sich direkt in der Eltern-Vorlagemappe befinden. Sollen alle Mappen aus allen untergeordneten Ebenen zurückgegeben werden, kann dies durch das Setzen des Parameters (logic3) auf true erreicht werden.

Im Parameter (int2) 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 Untermappe 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.

Die Informationen werden dabei je nach Option unterschiedlich abgelegt:

  • (logic3) = FALSE (Standard)

    Name In der Eigenschaft "Name" wird die Nummer der Arbeitsmappe gespeichert
    Custom In der Eigenschaft "Custom" wird ein Vorzeichen (+ oder -) gefolgt vom Namen der Arbeitsmappe gespeichert.
    Das Vorzeichen sagt aus, ob zu dieser Mappe weitere Untermappen vorhanden sind: "+", es sind Untermappen vorhanden, "-", es sind keine Untermappen vorhanden.

  • (logic3) = TRUE

    Name In der Eigenschaft "Name" wird die Nummer der Arbeitsmappe gespeichert
    Custom In der Eigenschaft "Custom" wird die Nummer der Elternmappe, gefolgt von einem Trennzeichen "#", anschließend ein Vorzeichen (+ oder -) gefolgt vom Namen der Arbeitsmappe gespeichert.
    Das Vorzeichen sagt aus, ob zu dieser Mappe weitere Untermappen vorhanden sind: "+", es sind Untermappen vorhanden, "-", es sind keine Untermappen vorhanden.

    BEISPIEL:

    12#-Arbeitsmappe1 - Diese Arbeitsmappe ist eine Untermappe der Mappe mit der Nummer 12. Sie besitzt keine Untermappen.

Über die Eigenschaft "ID" des Items kann die Mappen-Unterteilung der Vorlagemappe abgefragt werden.

Folgende Konstanten können zurückgegeben werden:

Konstante Wert Bedeutung
sAfAbmPartNone
0
keine virtuelle Unterteilung
sAfAbmPartYear
1
virtuelle Jahres-Unterteilung unter der Arbeitsmappe
sAfAbmPartYearMonth
2
virtuelle Jahres- und Monats-Unterteilung unter der Arbeitsmappe
sAfAbmPartYearMonthDay
3
virtuelle Jahres-, Monats- und Tages-Unterteilung unter der Arbeitsmappe
sAfAbmPartScript
4
virtuelle Unterteilung über ein Skript

Wird ein ungültiger Deskriptor ü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
sAfErrNoRecAbm -20026 Die übergebene Vorlagemappe existiert nicht.
sAfErrInvalidAbmType -20041 Die übergebene Mappe ist keine Vorlagemappe.

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