tResult # AfAbmPropSet(600448, sAfAbmPropPartition, sAfAbmPartYearMonth);
AfAbmPropSet: Unterschied zwischen den Versionen
Zur Navigation springen
Zur Suche springen
Jens (Diskussion | Beiträge) K Stand 4.1.08 |
Jens (Diskussion | Beiträge) K Stand 4.1.13 Beispiel ScriptAPI ergänzt |
||
| (4 dazwischenliegende Versionen desselben Benutzers werden nicht angezeigt) | |||
| Zeile 6: | Zeile 6: | ||
</tr> | </tr> | ||
<tr class="ProcSyntax"> | <tr class="ProcSyntax"> | ||
<td class="title"> | <td class="title"> AfAbmPropSet(int1, int2, int3) : int</td> | ||
<td class="platforms"> | <td class="platforms"> | ||
[[file:DE_SymbolAPI.gif|alt=Ausführbar von der API|link=Befehle der Schnittstellen]][[file:DE_SymbolDLL.gif|alt=Ausführbar von der Programmierschnittstelle|link=Befehle der Schnittstellen]][[file:DE_SymbolARC.gif|alt=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_SymbolDLL.gif|alt=Ausführbar von der Programmierschnittstelle (DLL)|link=Befehle der Schnittstellen|Ausführbar von der Programmierschnittstelle (DLL)]][[file:DE_SymbolARC.gif|alt=Ausführbar mit der Application Remote Control|link=Befehle der Schnittstellen|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 46: | Zeile 46: | ||
<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]], | ||
[[ | [[AfAbmPropGet#|AfAbmPropGet()]] | ||
</td> | </td> | ||
</tr> | </tr> | ||
| Zeile 178: | Zeile 178: | ||
</table> | </table> | ||
== Beispiel == | |||
<p>In der Ergebnisdatei wird in der ersten Zeile die übergebene Anweisung | <tabber> | ||
geschrieben. In der zweiten Zeile wird der Rückgabewert der Funktion gespeichert.</p></ | |-|ScritAPI= | ||
<pre class=source> | |||
tResult # AfAbmPropSet(600448, sAfAbmPropPartition, sAfAbmPartYearMonth); | |||
</pre> | |||
|-|ArcFlowRemoteControl= | |||
<pre class=source> | |||
af_rmtControl.exe /user=admin /password=troja /action=fnc /fnc=AfAbmPropSet /AbmNr=600448 /PropType=2 /PropContent=2 /RsltPath=c:\temp\AFAPIRES.TXT | |||
</pre> | |||
<p>In der Ergebnisdatei wird in der ersten Zeile die übergebene Anweisung geschrieben. In der zweiten Zeile wird der Rückgabewert der Funktion gespeichert.</p> | |||
</tabber> | |||
<p> | <p> | ||
| Zeile 251: | Zeile 259: | ||
</translate> | </translate> | ||
[[Category:Befehle für Arbeitsmappen]] | [[Category:Befehle für Arbeitsmappen]] | ||
Aktuelle Version vom 5. Januar 2026, 14:50 Uhr
 |
|||||||||||||||||||||
| AfAbmPropSet(int1, int2, int3) : int |
|
||||||||||||||||||||
| Eigenschaft einer Arbeitsmappe setzen | |||||||||||||||||||||
|
|||||||||||||||||||||
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 | Arbeitsmappentyp | |
| sAfAbmPropPartition | Arbeitsmappenunterteilung | |
| sAfAbmPropAbmFldGrp | Mappenfeldgruppen-Zuweisung |
Der Arbeitsmappentyp kann folgende Werte annehmen:
| Konstante | Wert | Eigenschaft |
| sAfAbmTypeNormal | Normale Arbeitsmappe | |
| sAfAbmTypeTemplate | Vorlagemappe |
Die Arbeitsmappenunterteilung kann folgende Werte annehmen:
| Konstante | Wert | Eigenschaft |
| sAfAbmPartNone | Keine Unterteilung | |
| sAfAbmPartYear | Unterteilung in Jahren | |
| sAfAbmPartYearMonth | Unterteilung in Jahren und Monaten | |
| sAfAbmPartYearMonthDay | Unterteilung in Jahren, Monaten und Tagen | |
| sAfAbmPartScript | 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. |
Beispiel
af_rmtControl.exe /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.
