tErr # AF.API:AfRunScript('MyScript', var tResultLogic, var tReturnString, tParameterAlpha1);
AfRunScript: Unterschied zwischen den Versionen
Zur Navigation springen
Zur Suche springen
Jens (Diskussion | Beiträge) K Stand 4.1.09 |
Jens (Diskussion | Beiträge) K Stand 4.1.14 Tabellen für Beispiele eingefügt |
||
| Zeile 61: | Zeile 61: | ||
</table> | </table> | ||
<div class="BigLang"> | <div class="BigLang"> | ||
Mit dieser Funktion kann ein Skript aufgerufen werden. Das Skript muss vor dem Aufruf mit der [[Script-API#|Script-API]] erstellt werden. Der Name des Skripts wird in (alpha1) angegeben. Nach erfolgreicher Ausführung des Skripts, steht der Rückgabewert des Skripts in der in (logic2) übergebenen Variablen. Innerhalb des aufgerufenen Skriptes kann in der globalen Variablen <font class=source>gAfApiAlphaVal</font> ein weiterer Rückgabewert gesetzt werden. Der Rückgabewert wird nach der Ausführung des Skripts in die Variable (alpha3) übertragen. Die Variable sollte bis zu 4096 Zeichen aufnehmen können. | |||
Dem aufgerufenen Skript können Parameter übergeben werden. Die Parameter werden in (alpha4) bis (alpha6) übergeben. Im aufgerufenen Skript stehen diese Werte in den globalen Variablen <font class=source>gAfApiCustomVal1</font>, <font class=source>gAfApiCustomVal2</font> und <font class=source>gAfApiCustomVal3</font> zur Verfügung. In jedem Parameter können bis zu 4096 Zeichen übergeben werden. | |||
== Beispiel == | |||
<tabber> | |||
|-|ArcFlowAPI= | |||
<pre class=source> | <pre class=source> | ||
tErr # AfRunScript('MyScript', var | tErr # AF.API:AfRunScript('MyScript', var tResultLogic, var tReturnString, tParameterAlpha1); | ||
</pre></ | </pre> | ||
</tabber> | |||
Neben den [[Allgemeine Fehlercodes#|allgemeinen Fehlerwerten]] | Neben den [[Allgemeine Fehlercodes#|allgemeinen Fehlerwerten]] | ||
können folgende Werte zurückgegeben werden: | können folgende Werte zurückgegeben werden: | ||
<table class=lang> | <table class=lang> | ||
<tr> | <tr> | ||
| Zeile 97: | Zeile 98: | ||
</table> | </table> | ||
Für weitere CONZEPT 16-spezifische Rückgabewerte siehe die | Für weitere CONZEPT 16-spezifische Rückgabewerte siehe die | ||
aktuelle CONZEPT 16-Hilfe. | aktuelle CONZEPT 16-Hilfe. | ||
</div> | </div> | ||
</translate> | </translate> | ||
[[Category:Allgemeine Befehle der API]] | [[Category:Allgemeine Befehle der API]] | ||
Version vom 7. November 2025, 13:57 Uhr
 |
|||||||||||||||||||||||||
| AfRunScript(alpha1, var logic2, var alpha3[, alpha4[, alpha5[, alpha6]]]) : int |
|
||||||||||||||||||||||||
| Aufrufen eines Skripts | |||||||||||||||||||||||||
|
|||||||||||||||||||||||||
Mit dieser Funktion kann ein Skript aufgerufen werden. Das Skript muss vor dem Aufruf mit der Script-API erstellt werden. Der Name des Skripts wird in (alpha1) angegeben. Nach erfolgreicher Ausführung des Skripts, steht der Rückgabewert des Skripts in der in (logic2) übergebenen Variablen. Innerhalb des aufgerufenen Skriptes kann in der globalen Variablen gAfApiAlphaVal ein weiterer Rückgabewert gesetzt werden. Der Rückgabewert wird nach der Ausführung des Skripts in die Variable (alpha3) übertragen. Die Variable sollte bis zu 4096 Zeichen aufnehmen können.
Dem aufgerufenen Skript können Parameter übergeben werden. Die Parameter werden in (alpha4) bis (alpha6) übergeben. Im aufgerufenen Skript stehen diese Werte in den globalen Variablen gAfApiCustomVal1, gAfApiCustomVal2 und gAfApiCustomVal3 zur Verfügung. In jedem Parameter können bis zu 4096 Zeichen übergeben werden.
Beispiel
Neben den allgemeinen Fehlerwerten können folgende Werte zurückgegeben werden:
| Konstante | Wert | Bedeutung |
| _rOk | 0 | Ok, kein Fehler aufgetreten. |
| _rNoRec | 5 | Das in (alpha1) angegebene Skript ist nicht vorhanden. |
Für weitere CONZEPT 16-spezifische Rückgabewerte siehe die aktuelle CONZEPT 16-Hilfe.
