getRecipe

[ Funktion ]

public static getRecipe (
    recipeName: string,
    path: string | null,
    callback: null | ((this: void, data: TcHmi.Server.RecipeManagement.IRecipeListResultObject) => void) = null
): TcHmi.IErrorDetails;

Liefert die Definition eines Rezepts.

Parameter

Name	Typ	Beschreibung
recipeName	string	Name des Rezepts. Dieser kann auch den vollen Pfad beinhalten. Als Trennzeichen für Ordner muss in diesem Fall '::' genutzt werden.
path	string, null	Pfad des Zielordners. Wird dieser nicht angegeben, so wird der Rezepttyp im Hauptordner angelegt.
callback [ Optional ]	(data: TcHmi.Server.RecipeManagement.IGetRecipeResultObject) => void, null	Asynchrone Callback Funktion, die ausgelöst wird, wenn die Aktion abgeschlossen wurde.

Rückgabewert

Typ	Beschreibung
TcHmi.IErrorDetails	Liefert eine Rückmeldung, ob die Operation erfolgreich abgeschickt worden konnte.

	Verfügbar ab Version 1.10.1171.142

Beispiel - JavaScript

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