watchRecipe

[ Funktion ]

public static watchRecipe(
    recipeName: string,
    path: string | null,
    options?: RecipeManagement.IRecipeWatchOptions | null,
    callback: null | ((this: void, data: TcHmi.Server.RecipeManagement.IWatchResultObject<TcHmi.Server.RecipeManagement.FolderRecipe>) => void) = null
): DestroyFunction;

Überwacht ein vorhandenes Rezept des Systems auf Änderungen.

Parameter

Name	Typ	Beschreibung
recipeTypeName	string	Name des Rezepttyps. Dieser kann auch den vollen Pfad beinhalten. Als Trennzeichen für Ordner muss in diesem Fall '::' genutzt werden.
path	string, null	Pfad des Zielordners.
options	TcHmi.Server.RecipeManagement.IRecipeWatchOptions, null	Optionen des Rezeptmanagement
callback [ Optional ]	(data: TcHmi.Server.RecipeManagement.IWatchResultObject<TcHmi.Server.RecipeManagement.FolderRecipe>) => void, null	Asynchrone Callback Funktion, die ausgelöst wird, wenn sich ein Wert geändert hat.

Rückgabewert

Typ	Beschreibung
DestroyFunction	Liefert eine Funktion zurück, durch deren Aufruf die Überwachung beendet werden kann und alle zugehörigen Resourcen freigegeben werden.

	Verfügbar ab Version 1.12

Beispiel - JavaScript

TcHmi.Server.RecipeManagement.watchRecipe (
    'recipeType10', 
    'testRecipeCategory', 
    null,
    function(data) {
        if (data.error === TcHmi.Errors.NONE) {
            console.log(data.value);
        } else {
            // Error
        }
    }
);