RecipeManCommands

Panoramica

Quando si esegue un comando su una ricetta, si ha un accesso ai dati interni. A seconda del tipo di dispositivo, questa operazione richiede alcuni millisecondi. Controllare che queste chiamate non siano eseguite dal task MAST o da un task con un watchdog configurato o un task in tempo reale. Ciò può portare a un errore dell'applicazione e il controller entrerà nello stato HALT.

Tenere presente che anche l'opzione Salvare automaticamente le variazioni dei file di ricette esegue l'accesso ai file a ogni modifica della ricetta. Se il salvataggio della ricetta è attivato dall'applicazione, è consigliabile disattivare questa opzione.

Valori restituiti

Per i possibili valori restituiti per i comandi delle ricette, vedere la Documentazione della libreria Recipe ManagementDocumentazione della libreria della Guida in linea di EcoStruxure Machine Expert.

CreateRecipe

Questo metodo crea una nuova ricetta nella definizione della ricetta specificata e successivamente legge i valori del controller nella nuova ricetta. Al termine, la nuova ricetta viene memorizzata nel file predefinito.

Parametro	Tipo di dati	Descrizione
RecipeDefinitionName:	STRING	Nome della definizione della ricetta.
RecipeName:	STRING	Nome della ricetta.

Valori restituiti: ERR_NO_RECIPE_MANAGER_SET, ERR_RECIPE_DEFINITION_NOT_FOUND, ERR_RECIPE_ALREADY_EXIST, ERR_FAILED, ERR_OK

CreateRecipeNoSave

Questo metodo crea una nuova ricetta nella definizione della ricetta specificata e successivamente legge i valori del controller nella nuova ricetta.

Parametro	Tipo di dati	Descrizione
RecipeDefinitionName:	STRING	Nome della definizione della ricetta.
RecipeName:	STRING	Nome della ricetta.

Valori restituiti: ERR_NO_RECIPE_MANAGER_SET, ERR_RECIPE_DEFINITION_NOT_FOUND, ERR_RECIPE_NOT_FOUND, ERR_FAILED, ERR_OK

DeleteRecipe

Questo metodo elimina una ricetta dalla definizione della ricetta.

Parametro	Tipo di dati	Descrizione
RecipeDefinitionName:	STRING	Nome della definizione della ricetta.
RecipeName:	STRING	Nome della ricetta.

Valori restituiti: ERR_NO_RECIPE_MANAGER_SET, ERR_RECIPE_DEFINITION_NOT_FOUND, ERR_RECIPE_NOT_FOUND, ERR_FAILED, ERR_OK

DeleteRecipeFile

Questo metodo elimina il file predefinito della ricetta da una ricetta.

Parametro	Tipo di dati	Descrizione
RecipeDefinitionName:	STRING	Nome della definizione della ricetta.
RecipeName:	STRING	Nome della ricetta.

Valori restituiti: ERR_NO_RECIPE_MANAGER_SET, ERR_RECIPE_DEFINITION_NOT_FOUND, ERR_RECIPE_NOT_FOUND, ERR_RECIPE_FILE_NOT_FOUND, ERR_OK

LoadAndWriteRecipe

Questo metodo carica una ricetta dal file predefinito della ricetta e successivamente scrive la ricetta nelle variabili del controller.

Parametro	Tipo di dati	Descrizione
RecipeDefinitionName:	STRING	Nome della definizione della ricetta.
RecipeName:	STRING	Nome della ricetta.

Valori restituiti: 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

LoadFromAndWriteRecipe

Questo metodo carica una ricetta dal file specificato della ricetta e successivamente scrive la ricetta nelle variabili del controller.

Parametro	Tipo di dati	Descrizione
RecipeDefinitionName:	STRING	Nome della definizione della ricetta.
RecipeName:	STRING	Nome della ricetta.
FileName:	STRING[255]	Nome del file.

Valori restituiti: 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

LoadRecipe

Questo metodo carica una ricetta dal file predefinito della ricetta. Il nome predefinito del file della ricetta è <ricetta>.<definizione ricetta>.<estensione ricetta>.

Parametro	Tipo di dati	Descrizione
RecipeDefinitionName:	STRING	Nome della definizione della ricetta.
RecipeName:	STRING	Nome della ricetta.

Valori restituiti: 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

ReadAndSaveAs

Questo metodo legge i valori del controller dalle variabili delle definizioni di ricetta e quindi memorizza il set di dati in un file ricetta senza modificare il file ricetta predefinito <ricetta.definizione ricetta.estensione>.

Parametro	Tipo di dati	Descrizione
RecipeDefinitionName:	STRING	Nome della definizione della ricetta. Vengono lette le variabili definite nella definizione di ricetta.
FileName:	STRING[255]	Il nome del file in cui è salvato il set di dati letto viene salvato come ricetta.

Valori restituiti: ERR_NO_RECIPE_MANAGER_SET, ERR_RECIPE_DEFINITION_NOT_FOUND, ERR_RECIPE_SAVE_ERR, ERR_OK

ReadAndSaveRecipe

Questo metodo legge i valori del controller nella ricetta e salva la ricetta nel file predefinito della ricetta.

Parametro	Tipo di dati	Descrizione
RecipeDefinitionName:	STRING	Nome della definizione della ricetta.
RecipeName:	STRING	Nome della ricetta.

Valori restituiti: ERR_NO_RECIPE_MANAGER_SET, ERR_RECIPE_DEFINITION_NOT_FOUND, ERR_RECIPE_NOT_FOUND, ERR_RECIPE_SAVE_ERR, ERR_FAILED, ERR_OK

ReadAndSaveRecipeAs

Questo metodo legge i valori del controller nella ricetta e salva la ricetta nel file specificato della ricetta. Il contenuto di un file esistente viene sovrascritto.

Parametro	Tipo di dati	Descrizione
RecipeDefinitionName:	STRING	Nome della definizione della ricetta.
RecipeName:	STRING	Nome della ricetta.
FileName:	STRING[255]	Nome del file.

Valori restituiti: ERR_NO_RECIPE_MANAGER_SET, ERR_RECIPE_DEFINITION_NOT_FOUND, ERR_RECIPE_NOT_FOUND, ERR_RECIPE_SAVE_ERR, ERR_FAILED, ERR_OK

SaveRecipe

Questo metodo salva la ricetta nel file predefinito della ricetta. Il contenuto di un file esistente viene sovrascritto. Il nome predefinito del file della ricetta è <ricetta>.<definizione ricetta>.<estensione ricetta>.

Parametro	Tipo di dati	Descrizione
RecipeDefinitionName:	STRING	Nome della definizione della ricetta.
RecipeName:	STRING	Nome della ricetta.

Valori restituiti: ERR_NO_RECIPE_MANAGER_SET, ERR_RECIPE_DEFINITION_NOT_FOUND, ERR_RECIPE_NOT_FOUND, ERR_RECIPE_SAVE_ERR, ERR_FAILED, ERR_OK

ReadRecipe

Questo metodo legge i valori del controller nella ricetta.

Parametro	Tipo di dati	Descrizione
RecipeDefinitionName:	STRING	Nome della definizione della ricetta.
RecipeName:	STRING	Nome della ricetta.

Valori restituiti: ERR_NO_RECIPE_MANAGER_SET, ERR_RECIPE_DEFINITION_NOT_FOUND, ERR_RECIPE_NOT_FOUND, ERR_FAILED, ERR_OK

WriteRecipe

Questo metodo scrive la ricetta nelle variabili del controller.

Parametro	Tipo di dati	Descrizione
RecipeDefinitionName:	STRING	Nome della definizione della ricetta.
RecipeName:	STRING	Nome della ricetta.

Valori restituiti: ERR_NO_RECIPE_MANAGER_SET, ERR_RECIPE_DEFINITION_NOT_FOUND, ERR_RECIPE_NOT_FOUND, ERR_FAILED, ERR_OK

ReloadRecipes

Questo metodo ricarica l'elenco delle ricette dal file system.

Parametro	Tipo di dati	Descrizione
RecipeDefinitionName:	STRING	Nome della definizione della ricetta.

Valori restituiti: ERR_NO_RECIPE_MANAGER_SET, ERR_RECIPE_DEFINITION_NOT_FOUND, ERR_FAILED, ERR_OK

GetRecipeCount

Questo metodo restituisce il numero di ricette dalla definizione della ricetta corrispondente.

Parametro	Tipo di dati	Descrizione
RecipeDefinitionName:	STRING	Nome della definizione della ricetta.

Valori restituiti: -1 : se la definizione della ricetta non viene trovata.

GetRecipeNames

Questo metodo restituisce i nomi delle ricette della definizione delle ricette corrispondente.

Parametro	Tipo di dati	Descrizione
RecipeDefinitionName:	STRING	Nome della definizione della ricetta.
pStrings :	POINTER TO ARRAY [] OF STRING	Stringhe dove devono essere salvati i valori della ricetta.
iSize :	INT	Dimensioni di un array di stringhe.
iStartIndex :	INT	L'indice iniziale; può essere utilizzato per una funzione di scorrimento.

Valori restituiti: ERR_NO_RECIPE_MANAGER_SET, ERR_RECIPE_DEFINITION_NOT_FOUND, ERR_FAILED, ERR_OK

Esempio:

Vi sono 50 ricette. Definire un array di stringhe per creare una tabella che visualizzi 10 nomi di ricette alla volta:

strArr: ARRAY[0..9] OF STRING;

Corrispondente a iStartIndex, i nomi delle ricette possono essere letti da un'area specifica.

iStartIndex := 0;

Vengono restituiti i nomi nell'intervallo 0...9.

iStartIndex := 20;

Vengono restituiti i nomi nell'intervallo 20...29. In questo esempio:

iSize := 10;

GetRecipeValues

Questo metodo restituisce i valori delle variabili della ricetta corrispondente.

Parametro	Tipo di dati	Descrizione
RecipeDefinitionName:	STRING	Nome della definizione della ricetta.
RecipeName :	STRING	Nome della ricetta.
pStrings :	POINTER TO ARRAY [] OF STRING	Stringhe dove devono essere salvati i valori della ricetta.
iSize :	INT	Dimensioni di un array di stringhe.
iStartIndex :	INT	L'indice iniziale; può essere utilizzato per una funzione di scorrimento.
iStringLength :	INT	Lunghezza della stringa nell'array.

Valori restituiti: ERR_NO_RECIPE_MANAGER_SET, ERR_RECIPE_DEFINITION_NOT_FOUND, ERR_RECIPE_NOT_FOUND, ERR_FAILED, ERR_OK

Esempio:

Vi sono 50 ricette. Definire un array di stringhe per creare una tabella che visualizzi 10 nomi di ricette alla volta:

strArr: ARRAY[0..9] OF STRING;

Corrispondente a iStartIndex, i nomi delle ricette possono essere letti da un'area specifica.

iStartIndex := 0;

Vengono restituiti i valori nell'intervallo 0...9.

iStartIndex := 20;

Vengono restituiti i valori nell'intervallo 20...29. In questo esempio:

iStringLength := 80;
iSize := 10;

GetRecipeVariableNames

Questo metodo restituisce il nome della variabile della ricetta corrispondente.

Parametro	Tipo di dati	Descrizione
RecipeDefinitionName:	STRING	Nome della definizione della ricetta.
RecipeName :	STRING	Nome della ricetta.
pStrings :	POINTER TO ARRAY [] OF STRING	Stringhe dove devono essere salvati i valori della ricetta.
iSize :	INT	Dimensioni di un array di stringhe.
iStartIndex :	INT	L'indice iniziale; può essere utilizzato per una funzione di scorrimento.

Valori restituiti: ERR_NO_RECIPE_MANAGER_SET, ERR_RECIPE_DEFINITION_NOT_FOUND, ERR_RECIPE_NOT_FOUND, ERR_FAILED, ERR_OK

Esempio:

Vi sono 50 ricette. Definire un array di stringhe per creare una tabella che visualizzi 10 nomi di ricette alla volta:

strArr: ARRAY[0..9] OF STRING;

Corrispondente a iStartIndex, i nomi delle ricette possono essere letti da un'area specifica.

iStartIndex := 0;

Vengono restituiti i nomi nell'intervallo 0...9.

iStartIndex := 20;

Vengono restituiti i nomi nell'intervallo 20...29. In questo esempio:

iSize := 10;

SetRecipeValues

Questo metodo consente di impostare i valori della ricetta nella ricetta corrispondente.

Parametro	Tipo di dati	Descrizione
RecipeDefinitionName:	STRING	Nome della definizione della ricetta.
RecipeName :	STRING	Nome della ricetta.
pStrings :	POINTER TO ARRAY [] OF STRING	Stringhe dove devono essere salvati i valori della ricetta.
iSize :	INT	Dimensioni di un array di stringhe.
iStartIndex :	INT	L'indice iniziale; può essere utilizzato per una funzione di scorrimento.

Valori restituiti: ERR_NO_RECIPE_MANAGER_SET, ERR_RECIPE_DEFINITION_NOT_FOUND, ERR_RECIPE_NOT_FOUND, ERR_FAILED, ERR_OK

Esempio:

Vi sono 50 ricette. Definire un array di stringhe per creare una tabella che visualizzi 10 nomi di ricette alla volta:

strArr: ARRAY[0..9] OF STRING;

Corrispondente a iStartIndex, i nomi delle ricette possono essere letti da un'area specifica.

iStartIndex := 0;

Vengono impostati i valori nell'intervallo 0...9.

iStartIndex := 20;

Vengono impostati i valori nell'intervallo 20...29. In questo esempio:

iStringLength := 80;
iSize := 10;

GetLastError

Questo metodo di tipo dati DWORD restituisce l'ultimo errore rilevato delle operazioni precedenti:

Valori restituiti: ERR_NO_RECIPE_MANAGER_SET, ERR_OK

ResetLastError

Questo metodo di tipo dati DWORD azzera l'ultimo errore rilevato.

Valori restituiti: ERR_NO_RECIPE_MANAGER_SET, ERR_OK

SetStoragePath

Questo metodo consente di impostare il percorso di archiviazione per il file della ricetta. Sovrascrive il Percorso file configurato nella finestra di dialogo Gestore di ricetta.

Parametro	Tipo di dati	Descrizione
stPath	STRING	Il metodo restituisce TRUE se il percorso è impostato, ad esempio: D:/recipefiles/. Il metodo restituisce FALSE: Se nessun Gestore di ricetta è disponibile nell'applicazione. Se non esiste alcuna definizione di ricetta disponibile sotto il nodo Gestore di ricetta.

Parametro

Tipo di dati

Descrizione

stPath

STRING

Il metodo restituisce TRUE se il percorso è impostato, ad esempio: D:/recipefiles/.

Il metodo restituisce FALSE:

Se nessun Gestore di ricetta è disponibile nell'applicazione.
Se non esiste alcuna definizione di ricetta disponibile sotto il nodo Gestore di ricetta.

Valori restituiti: ERR_NO_RECIPE_MANAGER_SET, ERR_OK