Lors de l'appel d'une commande de recette, le programme accède aux données internes. Suivant le type d'équipement, cela peut prendre plusieurs millisecondes. Veillez à ce que ces appels ne soient pas effectués par la tâche MAST ou par une tâche pour laquelle une horloge de surveillance ou une tâche en temps réel est configurée. Une erreur d'application risque d'être renvoyée et le contrôleur passera à l'état HALT.
Notez que l'option
effectue également un accès au fichier à chaque modification de la recette. Désactivez cette option si l'enregistrement de la recette est déclenché par l'application.Les valeurs de retour possibles pour les commandes de recette sont décrites dans la rubrique Recipe Management - Documentation de bibliothèque disponible dans l'aide en ligne de EcoStruxure Machine Expert.
Cette méthode crée une recette dans la définition de recette indiquée, et lit ensuite les valeurs du contrôleur dans cette nouvelle recette. À l'issue de l'opération, la nouvelle recette est enregistrée dans le fichier par défaut.
Paramètre |
Type de données |
Description |
---|---|---|
RecipeDefinitionName : |
STRING |
Nom de la définition de recette. |
RecipeName : |
STRING |
Nom de la recette. |
Valeurs renvoyées : ERR_NO_RECIPE_MANAGER_SET, ERR_RECIPE_DEFINITION_NOT_FOUND, ERR_RECIPE_ALREADY_EXIST, ERR_FAILED, ERR_OK
Cette méthode crée une recette dans la définition de recette indiquée, puis y place les valeurs lues sur le contrôleur.
Paramètre |
Type de données |
Description |
---|---|---|
RecipeDefinitionName : |
STRING |
Nom de la définition de recette. |
RecipeName : |
STRING |
Nom de la recette. |
Valeurs renvoyées : ERR_NO_RECIPE_MANAGER_SET, ERR_RECIPE_DEFINITION_NOT_FOUND, ERR_RECIPE_NOT_FOUND, ERR_FAILED, ERR_OK
Cette méthode supprime une recette d'une définition de recette.
Paramètre |
Type de données |
Description |
---|---|---|
RecipeDefinitionName : |
STRING |
Nom de la définition de recette. |
RecipeName : |
STRING |
Nom de la recette. |
Valeurs renvoyées : ERR_NO_RECIPE_MANAGER_SET, ERR_RECIPE_DEFINITION_NOT_FOUND, ERR_RECIPE_NOT_FOUND, ERR_FAILED, ERR_OK
Cette méthode supprime le fichier de recette par défaut d'une recette.
Paramètre |
Type de données |
Description |
---|---|---|
RecipeDefinitionName : |
STRING |
Nom de la définition de recette. |
RecipeName : |
STRING |
Nom de la recette. |
Valeurs renvoyées : ERR_NO_RECIPE_MANAGER_SET, ERR_RECIPE_DEFINITION_NOT_FOUND, ERR_RECIPE_NOT_FOUND, ERR_RECIPE_FILE_NOT_FOUND, ERR_OK
Cette méthode charge une recette à partir du fichier de recette par défaut, et écrit ensuite la recette dans les variables du contrôleur.
Paramètre |
Type de données |
Description |
---|---|---|
RecipeDefinitionName : |
STRING |
Nom de la définition de recette. |
RecipeName : |
STRING |
Nom de la recette. |
Valeurs renvoyées : ERR_NO_RECIPE_MANAGER_SET, ERR_RECIPE_DEFINITION_NOT_FOUND, ERR_RECIPE_NOT_FOUND, ERR_RECIPE_FILE_NOT_FOUND, ERR_RECIPE_MISMATCH, ERR_FAILED, ERR_OK
Cette méthode charge une recette à partir du fichier de recette indiqué, et écrit ensuite la recette dans les variables du contrôleur.
Paramètre |
Type de données |
Description |
---|---|---|
RecipeDefinitionName : |
STRING |
Nom de la définition de recette. |
RecipeName : |
STRING |
Nom de la recette. |
FileName : |
STRING [255] |
Nom du fichier. |
Valeurs renvoyées : ERR_NO_RECIPE_MANAGER_SET, ERR_RECIPE_DEFINITION_NOT_FOUND, ERR_RECIPE_NOT_FOUND, ERR_RECIPE_FILE_NOT_FOUND, ERR_RECIPE_MISMATCH, ERR_FAILED, ERR_OK
Cette méthode charge une recette à partir du fichier de recette par défaut. Le nom de fichier de recette par défaut est <recette>.<définition de la recette>.<extension de la recette>.
Paramètre |
Type de données |
Description |
---|---|---|
RecipeDefinitionName : |
STRING |
Nom de la définition de recette. |
RecipeName : |
STRING |
Nom de la recette. |
Valeurs renvoyées : ERR_NO_RECIPE_MANAGER_SET, ERR_RECIPE_DEFINITION_NOT_FOUND, ERR_RECIPE_NOT_FOUND, ERR_RECIPE_FILE_NOT_FOUND, ERR_RECIPE_MISMATCH, ERR_FAILED, ERR_OK
Cette méthode lit les valeurs des variables des définitions de recette sur le contrôleur, puis les stocke dans un fichier sans modifier le fichier de recette par défaut <recette.définition de recette.extension>.
Paramètre |
Type de données |
Description |
---|---|---|
RecipeDefinitionName : |
STRING |
Nom de la définition de recette. Les variables définies dans la définition de recette sont lues. |
FileName : |
STRING[255] |
Nom du fichier dans lequel les données lues sont enregistrées en tant que recette. |
Valeurs renvoyées : ERR_NO_RECIPE_MANAGER_SET, ERR_RECIPE_DEFINITION_NOT_FOUND, ERR_RECIPE_SAVE_ERR, ERR_OK
Cette méthode lit les valeurs du contrôleur dans la recette, et enregistre ensuite celle-ci dans le fichier de recette par défaut.
Paramètre |
Type de données |
Description |
---|---|---|
RecipeDefinitionName : |
STRING |
Nom de la définition de recette. |
RecipeName : |
STRING |
Nom de la recette. |
Valeurs renvoyées : ERR_NO_RECIPE_MANAGER_SET, ERR_RECIPE_DEFINITION_NOT_FOUND, ERR_RECIPE_NOT_FOUND, ERR_RECIPE_SAVE_ERR, ERR_FAILED, ERR_OK
Cette méthode lit les valeurs du contrôleur dans la recette, et enregistre ensuite celle-ci dans le fichier de recette indiqué. Si le fichier existe déjà, son contenu est remplacé.
Paramètre |
Type de données |
Description |
---|---|---|
RecipeDefinitionName : |
STRING |
Nom de la définition de recette. |
RecipeName : |
STRING |
Nom de la recette. |
FileName : |
STRING [255] |
Nom du fichier. |
Valeurs renvoyées : ERR_NO_RECIPE_MANAGER_SET, ERR_RECIPE_DEFINITION_NOT_FOUND, ERR_RECIPE_NOT_FOUND, ERR_RECIPE_SAVE_ERR, ERR_FAILED, ERR_OK
Cette méthode enregistre la recette dans le fichier de recette par défaut. Si le fichier existe déjà, son contenu est remplacé. Le nom de fichier de recette par défaut est <recette>.<définition de la recette>.<extension de la recette>.
Paramètre |
Type de données |
Description |
---|---|---|
RecipeDefinitionName : |
STRING |
Nom de la définition de recette. |
RecipeName : |
STRING |
Nom de la recette. |
Valeurs renvoyées : ERR_NO_RECIPE_MANAGER_SET, ERR_RECIPE_DEFINITION_NOT_FOUND, ERR_RECIPE_NOT_FOUND, ERR_RECIPE_SAVE_ERR, ERR_FAILED, ERR_OK
Cette méthode lit les valeurs du contrôleur dans la recette.
Paramètre |
Type de données |
Description |
---|---|---|
RecipeDefinitionName : |
STRING |
Nom de la définition de recette. |
RecipeName : |
STRING |
Nom de la recette. |
Valeurs renvoyées : ERR_NO_RECIPE_MANAGER_SET, ERR_RECIPE_DEFINITION_NOT_FOUND, ERR_RECIPE_NOT_FOUND, ERR_FAILED, ERR_OK
Cette méthode écrit la recette dans les variables du contrôleur.
Paramètre |
Type de données |
Description |
---|---|---|
RecipeDefinitionName : |
STRING |
Nom de la définition de recette. |
RecipeName : |
STRING |
Nom de la recette. |
Valeurs renvoyées : ERR_NO_RECIPE_MANAGER_SET, ERR_RECIPE_DEFINITION_NOT_FOUND, ERR_RECIPE_NOT_FOUND, ERR_FAILED, ERR_OK
Cette méthode recharge la liste des recettes à partir du système de fichiers.
Paramètre |
Type de données |
Description |
---|---|---|
RecipeDefinitionName : |
STRING |
Nom de la définition de recette. |
Valeurs renvoyées : ERR_NO_RECIPE_MANAGER_SET, ERR_RECIPE_DEFINITION_NOT_FOUND, ERR_FAILED, ERR_OK
Cette méthode renvoie le nombre de recettes conformément à la définition de recette correspondante.
Paramètre |
Type de données |
Description |
---|---|---|
RecipeDefinitionName : |
STRING |
Nom de la définition de recette. |
Valeurs renvoyées : -1 : si la définition de recette est introuvable.
Cette méthode renvoie les noms des recettes à partir de la définition de recette correspondante.
Paramètre |
Type de données |
Description |
---|---|---|
RecipeDefinitionName : |
STRING |
Nom de la définition de recette. |
pStrings : |
POINTER TO ARRAY [] OF STRING |
Chaînes dans lesquelles doivent être enregistrées les valeurs de recette. |
iSize : |
INT |
Taille d'un tableau de chaînes. |
iStartIndex : |
INT |
Index de début ; utilisable pour une fonction de défilement. |
Valeurs renvoyées : ERR_NO_RECIPE_MANAGER_SET, ERR_RECIPE_DEFINITION_NOT_FOUND, ERR_FAILED, ERR_OK
Exemple :
Il y a 50 recettes. Pour générer un tableau qui présente les noms de recette 10 par 10, définissez un tableau de chaînes :
strArr: ARRAY[0..9] OF STRING;
Il est possible de lire les noms de recette à partir d'une zone spécifique correspondant à l'index iStartIndex.
iStartIndex := 0;
Les noms 0 à 9 sont renvoyés.
iStartIndex := 20;
Les noms 20 à 29 sont renvoyés. Dans cet exemple :
iSize := 10;
Cette méthode renvoie les valeurs des variables de recette à partir de la recette correspondante.
Paramètre |
Type de données |
Description |
---|---|---|
RecipeDefinitionName : |
STRING |
Nom de la définition de recette. |
RecipeName : |
STRING |
Nom de la recette. |
pStrings : |
POINTER TO ARRAY [] OF STRING |
Chaînes dans lesquelles doivent être enregistrées les valeurs de recette. |
iSize : |
INT |
Taille d'un tableau de chaînes. |
iStartIndex : |
INT |
Index de début ; utilisable pour une fonction de défilement. |
iStringLength : |
INT |
Longueur de la chaîne de caractères dans le tableau. |
Valeurs renvoyées : ERR_NO_RECIPE_MANAGER_SET, ERR_RECIPE_DEFINITION_NOT_FOUND, ERR_RECIPE_NOT_FOUND, ERR_FAILED, ERR_OK
Exemple :
Il y a 50 recettes. Pour générer un tableau qui présente les noms de recette 10 par 10, définissez un tableau de chaînes :
strArr: ARRAY[0..9] OF STRING;
Il est possible de lire les noms de recette à partir d'une zone spécifique correspondant à l'index iStartIndex.
iStartIndex := 0;
Les valeurs 0 à 9 sont renvoyées.
iStartIndex := 20;
Les valeurs 20 à 29 sont renvoyées. Dans cet exemple :
iStringLength := 80;
iSize := 10;
Cette méthode renvoie le nom des variables de la recette correspondante.
Paramètre |
Type de données |
Description |
---|---|---|
RecipeDefinitionName : |
STRING |
Nom de la définition de recette. |
RecipeName : |
STRING |
Nom de la recette. |
pStrings : |
POINTER TO ARRAY [] OF STRING |
Chaînes dans lesquelles doivent être enregistrées les valeurs de recette. |
iSize : |
INT |
Taille d'un tableau de chaînes. |
iStartIndex : |
INT |
Index de début ; utilisable pour une fonction de défilement. |
Valeurs renvoyées : ERR_NO_RECIPE_MANAGER_SET, ERR_RECIPE_DEFINITION_NOT_FOUND, ERR_RECIPE_NOT_FOUND, ERR_FAILED, ERR_OK
Exemple :
Il y a 50 recettes. Pour générer un tableau qui présente les noms de recette 10 par 10, définissez un tableau de chaînes :
strArr: ARRAY[0..9] OF STRING;
Il est possible de lire les noms de recette à partir d'une zone spécifique correspondant à l'index iStartIndex.
iStartIndex := 0;
Les noms 0 à 9 sont renvoyés.
iStartIndex := 20;
Les noms 20 à 29 sont renvoyés. Dans cet exemple :
iSize := 10;
Cette méthode définit les valeurs des recettes dans la recette correspondante.
Paramètre |
Type de données |
Description |
---|---|---|
RecipeDefinitionName : |
STRING |
Nom de la définition de recette. |
RecipeName : |
STRING |
Nom de la recette. |
pStrings : |
POINTER TO ARRAY [] OF STRING |
Chaînes dans lesquelles doivent être enregistrées les valeurs de recette. |
iSize : |
INT |
Taille d'un tableau de chaînes. |
iStartIndex : |
INT |
Index de début ; utilisable pour une fonction de défilement. |
Valeurs renvoyées : ERR_NO_RECIPE_MANAGER_SET, ERR_RECIPE_DEFINITION_NOT_FOUND, ERR_RECIPE_NOT_FOUND, ERR_FAILED, ERR_OK
Exemple :
Il y a 50 recettes. Pour générer un tableau qui présente les noms de recette 10 par 10, définissez un tableau de chaînes :
strArr: ARRAY[0..9] OF STRING;
Il est possible de lire les noms de recette à partir d'une zone spécifique correspondant à l'index iStartIndex.
iStartIndex := 0;
Les valeurs 0 à 9 sont définies.
iStartIndex := 20;
Les valeurs 20 à 29 sont définies. Dans cet exemple :
iStringLength := 80;
iSize := 10;
Cette méthode de type de données DWORD renvoie la dernière erreur détectée dans les opérations précédentes.
Valeurs renvoyées : ERR_NO_RECIPE_MANAGER_SET, ERR_OK
Cette méthode de type de données DWORD réinitialise la dernière erreur détectée.
Valeurs renvoyées : ERR_NO_RECIPE_MANAGER_SET, ERR_OK
Cette méthode vous permet de définir le chemin d'enregistrement du fichier de recette. Elle remplace le boîte de dialogue .
configuré dans la
Paramètre |
Type de données |
Description |
---|---|---|
stPath |
STRING |
La méthode renvoie TRUE si le chemin est défini, par exemple : D:/recipefiles/. La méthode renvoie FALSE :
|
Valeurs renvoyées : ERR_NO_RECIPE_MANAGER_SET, ERR_OK