AfAboLstGet

AfAboLstGet(handle1[, alpha2, alpha3[, int4, alpha5[, int6]]]) : int
Liste der Abonnements ermitteln
handle1 Deskriptor einer leeren Cte-Liste alpha2 Benutzertyp (optional) sAfAboUserTypeUsr 'B' Benutzer sAfAboUserTypeUsrGrp 'E' Benutzergruppe sAfAboUserTypeSab 'S' Sachbearbeiter sAfAboUserTypeSabGrp 'G' Sachbearbeitergruppe alpha3 Benutzername oder -gruppe bzw. Sachbearbeitername oder -gruppe (optional) int4 Objekttyp (optional) sAfAboTypeABM 1 Arbeitsmappe sAfAboTypeARC 2 Archiv sAfAboTypeANH 3 Anhangdatei alpha5 Arbeitsmappen-Id oder Archivnummer (optional) int6 Sortierung (optional) sAfAboSortTypeId 0 nach Id (default) sAfAboSortTypeName 1 nach Abonnementname sAfAboSortTypeObjType 2 nach Objekttyp sAfAboSortTypeUser 3 nach Benutzer sAfAboSortTypeDueDate 4 nach Fälligkeit Resultat int Fehlerwert Siehe Verwandte Befehle, AfAboRead()

Mit dieser Anweisung wird eine Liste von Abonnements zurückgegeben. In (handle1) wird eine leere CTE-Liste übergeben, die zuvor mit AfCteOpen() angelegt werden muss. Werden keine weiteren Parameter angegeben, wird eine Liste mit allen Abonnements zurückgegeben. Nach erfolgreicher Ausführung der Anweisung, wird für jedes Abonnement ein Element in der Liste erzeugt. Der Name des Abonnements befindet sich in der Eigenschaft "Name", die Id des Abonnements in der Eigenschaft "Id" und eine Kombination aus Objekttyp und Objektnummer in der Eigenschaft Custom.

Beispiel:

tAboList # AfCteOpen(_CteList);
tResult # AfAboLstGet(tAboList);
for tAboItem # tAboList->CteRead(_CteFirst);
loop tAboItem # tAboList->CteRead(_CteNext, tAboItem);
while (tAboItem > 0)
{
  tAboName # tAboItem->spName;
  tAboId # tAboItem->spId;
  tAboObjectType # AfStrGet(tAboItem->spCustom, '#', 1);
  switch (tAboObjectType)
  {
    case sAfAboTypeABM : 
    {
      tAbmId # CnvIA(AfStrGet(tAboItem->spCustom, '#', 2));
    }
    case sAfAboTypeARC : 
    {
      tArcNr # AfStrGet(tAboItem->spCustom, '#', 2);
    }
    case sAfAboTypeANH : 
    {
      tArcNr # AfStrGet(tAboItem->spCustom, '#', 2);
      tArcFileNr # CnvIA(AfStrGet(tAboItem->spCustom, '#', 3));
    }
  }
}
tCteList->AfCteCloseAll();

Der Inhalt der Liste kann durch die Angabe von optionalen Parametern eingeschränkt werden. In (alpha2) und (alpha3) kann ein Objekttyp und ein Benutzername, eine Benutzergruppe, ein Sachbearbeiter oder eine Sachbearbeitergruppe angegeben werden. Es werden dann nur die Abonnements zurückgegeben, die den entsprechenden Personenkreis informieren würden.

Für den Benutzertyp können folgende Konstanten übergeben werden:

sAfAboUserTypeUsr	'B'	Benutzer
sAfAboUserTypeUsrGrp	'E'	Benutzergruppe
sAfAboUserTypeSab	'S'	Sachbearbeiter
sAfAboUserTypeSabGrp	'G'	Sachbearbeitergruppe

Beispiele:

tResult # AfAboLstGet(tAboList, 'admin', sAfAboUserTypeUsr); // User "Admin"
tResult # AfAboLstGet(tAboList, 'Administratoren', sAfAboUserTypeUsrGrp); // Usergroup "Administrator"
tResult # AfAboLstGet(tAboList, 'DST', sAfAboUserTypeSab); // Person "DST"
tResult # AfAboLstGet(tAboList, 'Einkauf', sAfAboUserTypeSabGrp); // Person group "Einkauf"

Die Liste kann auch auf ein Objekt (Arbeitsmappe, Archiv oder Anhangdatei) eingeschränkt werden. Dazu wird der Objekttyp in (int4) und das entsprechende Objekt in (alpha5) angegeben. Das Objekt ist die in eine Zeichenkette gewandelte Id der Arbeitsmappe, die Archivnummer oder eine Kombination aus Archivnummer und Anhangdateinummer. In (int4) können folgende Konstanten übergeben werden:

sAfAboTypeABM	1	Arbeitsmappe
sAfAboTypeARC	2	Archiv
sAfAboTypeANH	3	Anhangdatei

Beispiele:

tResult # AfAboLstGet(tAboList, '', '', CnvAI(tAbmId), sAfAboTypeABM);
tResult # AfAboLstGet(tAboList, '', '', tArcNr, sAfAboTypeARC);
tResult # AfAboLstGet(tAboList, '', '', tArcNr+'#'+CnvAI(tArcFileNr), sAfAboTypeANH);

Durch eine Angabe in (int6) kann die zurückgegebene Liste sortiert werden. Folgende Konstanten können übergeben werden:

sAfAboSortTypeId	0	nach Id (default)
sAfAboSortTypeName	1	nach Abonnementname
sAfAboSortTypeObjType	2	nach Objekttyp
sAfAboSortTypeUser	3	nach Benutzer
sAfAboSortTypeDueDate	4	nach Fälligkeit

Die Parameter für Benutzer, Objekt und Sortierung können auch miteinaner kombiniert werden. Es können alle Abonnements des Sachbearbeiters "DST" einer Arbeitsmappe sortiert nach Fälligkeit durch die Anweisung AfAboLstGet(tAboList, 'DST', sAfAboUserTypeSab, CnvAI(tAbmId), sAfAboTypeABM, sAfAboSortTypeDueDate) ermittelt werden.

Neben den allgemeinen Fehlerwerten können folgende Werte zurückgegeben werden:

Konstante	Wert	Bedeutung
_ErrOk	0	ok - kein Fehler aufgetreten
_ErrHdlInvalid	-191	Der übergebene Deskriptor ist ungültig.
_rNoRec	5	Es wurde nur einer der Parameter (alpha2)/(alpha3) oder (int4)/(alpha5) angegeben.

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