AfAbmPropSet

Aus ArcFlow Wiki
Zur Navigation springen Zur Suche springen
Diese Seite enthält Bearbeitungen, die nicht zum Übersetzen freigegeben sind.
 AfAbmPropSet(int1, int2, int3) : int

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

Eigenschaft einer Arbeitsmappe setzen
int1 Nummer der Arbeitsmappe
int2 Eigenschaft
int3 Wert der Eigenschaft
Resultat int Fehlerwert
Siehe

Verwandte Befehle, AfAbmPropGet()

Diese Funktion setzt den Wert der Arbeitsmappeneigenschaft (int2) der Arbeitsmappe (int1). Der Wert wird dabei auf den in (int3) übergebenen Wert gesetzt.

Konnte die Funktion erfolgreich ausgeführt werden, wird _ErrOk zurückgegeben. Für den Fall, dass die Eigenschaft bereits editiert und daher gesperrt ist, wird _rLocked zurückgegeben.

Folgende Eigenschaften können gesetzt werden:

Konstante Wert Eigenschaft
sAfAbmPropType
1
Arbeitsmappentyp
sAfAbmPropPartition
2
Arbeitsmappenunterteilung
sAfAbmPropAbmFldGrp
3
Mappenfeldgruppen-Zuweisung

Der Arbeitsmappentyp kann folgende Werte annehmen:

Konstante Wert Eigenschaft
sAfAbmTypeNormal
0
Normale Arbeitsmappe
sAfAbmTypeTemplate
1
Vorlagemappe

Die Arbeitsmappenunterteilung kann folgende Werte annehmen:

Konstante Wert Eigenschaft
sAfAbmPartNone
0
Keine Unterteilung
sAfAbmPartYear
1
Unterteilung in Jahren
sAfAbmPartYearMonth
2
Unterteilung in Jahren und Monaten
sAfAbmPartYearMonthDay
3
Unterteilung in Jahren, Monaten und Tagen
sAfAbmPartScript
4
Unterteilung über ein Skript

Falls bei Angabe der Eigenschaftskonstante sAfAbmPropFldGrp 0 übergeben wird, wird die Zuweisung zur Mappenfeldgruppe entfernt.

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

/AbmNr Nummer der Arbeitsmappe
/PropType Eigenschaft
/PropContent Wert der Eigenschaft
/RsltPath Pfad und Name der externen Datei, in der das Ergebnis gespeichert wird.

Zum Beispiel:
/user=admin /password=troja /action=fnc /fnc=AfAbmPropSet /AbmNr=600448 /PropType=2 /PropContent=2 /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.

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

Konstante Wert Bedeutung
_ErrOk 0 ok - kein Fehler aufgetreten
_rLocked 1 Datensatz ist gesperrt - Die Eigenschaft ist bereits gesperrt und kann daher nicht editiert werden.
sAfErrNoRecAbm -20026 Die Arbeitsmappe existiert nicht.
sAfErrNoRights -20029 Die Berechtigung ist nicht ausreichend.
sAfErrInvalidAbmType -20041 Ungültiger Arbeitsmappentyp.
sAfErrInvalidAbmPartition -20042 Arbeitsmappenunterteilung ungültig
sAfErrInvalidProperty -20043 Die angegebene Eigenschaft ist nicht vorhanden.

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