ActivateRecipe

function ActivateRecipe(ctx: TcHmi.SelectableRequired<TcHmi.Context, 'success' | 'error'>, recipeReference: string): void

Die Funktion ActivateRecipe aktiviert beim Ausführen das im Parameter definierte Rezept.

Parameter

Name	Typ	Beschreibung
ctx Verfügbar ab Version 1.10	TcHmi.SelectableRequired<TcHmi.Context>	Kontext Objekt Muss bei der Verwendung in einem Trigger oder einem Funktionsausdruck nicht vom Anwender angegeben werden. Die Übergabe und die Auswertung erfolgt in diesem Fall über den entsprechenden Parser. Wird vom Aufrufer verwendet, um dem Framework bei der Ausführung Erfolg oder Fehlschlag zu signalisieren. Bei direkter Verwendung der Funktion in JavaScript/TypeScript muss das Kontext-Objekt beim Aufruf übergeben und ggf. ausgewertet werden.
recipeReference	String	Die Referenz des Rezeptes (Pfad plus Name), welches aktiviert werden soll.

Name

Typ

Beschreibung

ctx

Verfügbar ab Version 1.10

TcHmi.SelectableRequired<TcHmi.Context>

Kontext Objekt

Muss bei der Verwendung in einem Trigger oder einem Funktionsausdruck nicht vom Anwender angegeben werden. Die Übergabe und die Auswertung erfolgt in diesem Fall über den entsprechenden Parser.

Wird vom Aufrufer verwendet, um dem Framework bei der Ausführung Erfolg oder Fehlschlag zu signalisieren.

Bei direkter Verwendung der Funktion in JavaScript/TypeScript muss das Kontext-Objekt beim Aufruf übergeben und ggf. ausgewertet werden.

recipeReference

String

Die Referenz des Rezeptes (Pfad plus Name), welches aktiviert werden soll.

Rückgabewert

Typ	Beschreibung
void	Kein Rückgabewert.

NuGet Paket: Beckhoff.TwinCAT.HMI.Functions

	NuGet-Pakete sind verfügbar ab Version 1.12.

	Verfügbar ab Version 1.10.1171.142