IPS_AbortScript

 bool IPS_AbortScript (int $SkriptID) 

Parameterliste

Rückgabewert

Konnte die Funktion erfolgreich ausgeführt werden, liefert sie als Ergebnis TRUE, andernfalls FALSE.

Beschreibung

Die Funktion bricht alle laufenden und alle wartenden Ausführungen des Ablaufplans mit der ID SkriptID ab. Die Ausführungen erhalten den Status "durch Benutzer abgebrochen". Ein gerade ausgeführter Schritt wird dabei nicht unterbrochen, nach seinem Ende werden keine weiteren Schritte mehr ausgeführt. Laufende Warte-Aktionen (z.B. "Warten") beenden ihre Wartezeit vorzeitig. Hat der Ablaufplan keine laufenden oder wartenden Ausführungen, passiert nichts.

Nur Ablaufpläne können abgebrochen werden. Bei einem PHP-Skript schlägt die Funktion mit "Aborting is only supported for flow scripts!" fehl, bei einer nicht existierenden ID mit "Script #... does not exist". Den Typ eines Skripts liefert IPS_GetScript.

Gestartet wird ein Ablaufplan beispielsweise mit IPS_RunScript oder IPS_RunScriptWait. Innerhalb eines Ablaufplans steht dafür die Aktion "Breche Ausführung ab" zur Verfügung.

Beispiel

// Bricht alle Ausführungen des Ablaufplans ab
IPS_AbortScript(12345 /*[Rollläden schließen]*/);