deleteRecipeEx

[ Funktion ]

public static deleteRecipeEx (
    recipeName: string,
    path: string | null,
    options?: TcHmi.RecipeManagement.IRecipeOptions | null,
    requestOptions: TcHmi.Server.IRequestOptions | null = null,
    callback: null | ((this: void, data: TcHmi.IResultObject) => void) = null
): TcHmi.IErrorDetails;

Löscht ein Rezept.

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.

options

TcHmi.Server.RecipeManagement.IRecipeOptions, null

Optionen des Rezeptmanagement

requestOptions

TcHmi.Server.IRequestOptions, null

Optionen des Server-Requests

callback [ Optional ]

(data: TcHmi.IResultObject) => 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.

deleteRecipeEx 1:

Verfügbar ab Version 1.10.1171.142

Beispiel - JavaScript

TcHmi.Server.RecipeManagement.deleteRecipeEx (
    'recipe10',
    'testRecipeCategory',
    null,
    {timeout: 2000},
    function(data) {
        if (data.error === TcHmi.Errors.NONE) {
            // Success
        } else {
            // Error
        }
    }
);