renameRecipe

[ Funktion ]

public static renameRecipe (
    recipeName: string,
    path: string | null,
    newName: string,
    newPath: string | null,
    callback: null | ((this: void, data: TcHmi.IResultObject) => void) = null
): TcHmi.IErrorDetails;

Benennt ein Rezept um.

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	Pfad des Zielordners. Wird dieser nicht angegeben, so wird der Rezepttyp im Hauptordner gesucht.
newName	string	Neuer Name des Rezepts. Dieser kann auch den vollen Pfad beinhalten. Als Trennzeichen für Ordner muss in diesem Fall '::' genutzt werden.
newPath	string	Pfad des neuen Zielordners. Wird dieser nicht angegeben, so wird der Rezepttyp im Hauptordner angelegt.
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.

	Verfügbar ab Version 1.10.1171.142

Beispiel - JavaScript

TcHmi.Server.RecipeManagement.renameRecipe (
    'recipe10', 
    'testRecipeCategory', 
    'rootRecipe11', // new name
    null, // new path not give so the recipe is moved to root folder
    function(data) {
        if (data.error === TcHmi.Errors.NONE) {
            // Success
        } else {
            // Error
        }
    }
);