AfAbmEdit

Aus ArcFlow Wiki
Version vom 16. Oktober 2024, 09:40 Uhr von Jens (Diskussion | Beiträge) (Stand 4.1.09)
(Unterschied) ← Nächstältere Version | Aktuelle Version (Unterschied) | Nächstjüngere Version → (Unterschied)
Zur Navigation springen Zur Suche springen
 AfAbmEdit(int1) : int

Ausführbar von der APIAusführbar von der ProgrammierschnittstelleAusführbar mit der Application Remote ControlAusführbar von der Script-API

Arbeitsmappe ändern
int1 Nummer der Arbeitsmappe
Feldpuffer
gAfAbmId int Id
gAfAbmName alpha(250) Name der Arbeitsmappe
gAfAbmParentId int Nummer der Eltern-Arbeitsmappe
gAfAbmDescr alpha(250) Beschreibung
gAfAbmCloseDate date Abschlussvorgabe
gAfAbmPartitioning int Mappenunterteilung
gAfAbmType int Typ der Arbeitsmappe
gAfAbmFldGrpId int Id der Mappenfeldgruppe
gAfAbmIcon int Id des Symbols der Arbeitsmappe
Resultat int Fehlerwert
Siehe

Verwandte Befehle, AfAbmCreate()

Diese Funktion ändert die Informationen einer Arbeitsmappe. Die Arbeitsmappe (int1) wird mit den neuen Informationen aus dem Feldpuffer gefüllt. Durch Ändern der Nummer der Elternmappe gAfAbmParentId kann eine Arbeitsmappe in eine andere Ebene verschoben werden. Alle untergeordneten Mappen und Archive werden mit verschoben.

Durch Setzen des Abschlussdatums gAfAbmCloseDate kann die Steuerung der automatischen Zuordnung anhand der bei der Arbeitsmappe definierten Stichwörter beeinflusst werden. Liegt das Abschlussdatum vor dem heutigen Datum, gilt die Mappe als abgeschlossen. Bei dieser Arbeitsmappe wird keine automatische Zuordnung der Stichwörter durchgeführt.

Über das Feld gAfAbmPartitioning kann definiert werden, wie die Arbeitsmappe virtuell unterteilt werden soll. Unter der Arbeitsmappe können automatisch Jahresmappen und gegebenenfalls auch Monatsordner angezeigt werden, um die zugewiesenen Archive zu gliedern. Folgende Konstanten können angegeben 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

In gAfAbmFldGrpId kann die ID der Mappenfeldgruppe angegeben werden. Wird 0 übergeben, bleibt die bisherige Mappenfeldgruppe erhalten. Bei Angabe von -1 wird die Mappenfeldgruppe von der Arbeitsmappe entfernt und die Mappenfelder geleert. Die Mappenfelder der Arbeitsmappe werden auch geleert, wenn eine neue Mappenfeldgruppe gesetzt wird.

Über die Variable gAfAbmIcon kann das Symbol der Arbeitsmappe gelesen und gesetzt werden.

Bei der Verwendung mit der Application Remote Control werden die Parameter mit folgenden Namen übergeben:

/AbmNr Nummer der Arbeitsmappe
/AbmParent Nummer der Eltern-Arbeitsmappe
/Name neuer Name der Arbeitsmappe (optional)
/Descr neue Beschreibung der Arbeitsmappe (optional)
/AbschlDat neues Abschlussdatum (optional)
/Partition neue Aufteilung der Arbeitsmappe (optional)
/AbmFldGrp Mappenfeldgruppe (optional)
/RsltPath Pfad und Name der externen Datei, in der das Ergebnis gespeichert wird (optional).

Zum Beispiel:
/user=admin /password=troja /action=fnc /fnc=AfAbmEdit /AbmNr=600448 /AbmParent=600234 /Name="Neuer Name" /Descr="Neue Beschreibung" /AbschlDat=0.0.0 /Partition=0 /AbmFldGrp=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.

Beispiel:

// Changing the subdivision
tErr # AfAbmRead(tAbmNo);
if (tErr = _ErrOk)
{
  gAfAbmPartitioning # sAfAbmPartYearMonth; 
  tErr # AfAbmEdit(tAbmNo);
  if (tErr != _ErrOk)
  {
    // Error handling AFAbmEdit()
    ...
  }
}
else
{
  // Error handling AFAbmRead()
  ...
}

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

Konstante Wert Bedeutung
_ErrOk 0 ok - kein Fehler aufgetreten
_rLocked 1 Die in (int1) übergebene Arbeitsmappe ist zur Zeit von einem anderen Benutzer gesperrt
_rExists 6 Die in gAfAbmName übergebene Arbeitsmappe existiert bereits
sAfErrNoRecAbm -20026 Die in (int1) übergebene Arbeitsmappe existiert nicht
sAfErrNoRecAbmFldGrp -20038 Die in gAfAbmFldGrpId übergebene Mappenfeldgruppe existiert nicht
sAfErrInvalidAbmIcon -20057 Das in gAfAbmIcon angegebene Icon ist nicht vorhanden

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