getRecipeType

[ Funktion ]

public static getRecipeType (
    recipeTypeName: string, 
    path: string | null,
    callback: null | ((this: void, data: TcHmi.Server.RecipeManagement.IRecipeTypeGetResultObject) => void) = null
): TcHmi.IErrorDetails;

Liefert die Definition eines Rezepttyps.

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	Pfad des Zielordners. Wird dieser nicht angegeben, so wird der Rezepttyp im Hauptordner angelegt.
callback [ Optional ]	(data: TcHmi.Server.RecipeManagement.IRecipeTypeGetResultObject) => 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.12

Beispiel - JavaScript

TcHmi.Server.RecipeManagement.getRecipeType (
    'recipeType10',
    'testRecipeCategory',
    function (data) {
        if (data.error === TcHmi.Errors.NONE) {
            // Success
        } else {
            // Error
        }
    }
);