getRecipe

[ Function ]

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

Supplies the definition of a recipe.

Parameter

Name

Type

Description

recipeName

string

Name of the recipe. The name may include the full path. In this case, '::' must be used as the separator for folders.

path

string, null

Path of the destination folder. If this is not specified, the recipe type is created in the main folder.

callback [ optional ]

(data: TcHmi.Server.RecipeManagement.IGetRecipeResultObject) => 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.

getRecipe 1:

Available from version 1.10.1171.142

Sample - JavaScript

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