renameRecipeType

[ Function ]

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

Renames a recipe type.

Parameter

Name	Type	Description
recipeTypeName	string	Name of the recipe type. The name may include the full path. In this case, '::' must be used as the separator for folders.
path	string	Path of the destination folder. If this is not specified, the recipe type is created in the main folder.
newName	string	New name of the recipe type. The name may include the full path. In this case, '::' must be used as the separator for folders.
newPath	string	Path of the new destination folder. If this is not specified, the recipe type is created in the main folder.
callback [ optional ]	(data: TcHmi.IResultObject) => void, null	Asynchronous callback function that is triggered once the action is completed.

Return value

Type	Description
TcHmi.IErrorDetails	Returns confirmation as to whether the operation was successfully sent.

	Available from version 1.10.1171.142

Sample - JavaScript

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