IRecipeDefinition2.GetRecipeVariableName (METH) ¶ METHOD GetRecipeVariableName : POINTER TO BYTE Returns the name of the recipe variable from the corresponding recipe at the given index. The variable name will be returned as a pointer to the zero terminated characters in STRING encoding. Note For performance reasons this function assumes that CurrentlySelectedRecipe is assigned! InOut: Scope Name Type Comment Return GetRecipeVariableName POINTER TO BYTE Input iVarIndex DINT The index of the variable within the recipe Output errorCode DWORD An error code representing the result of the operation
RDT_Client.Busy (PROP) ¶ PROPERTY Busy : BOOL Operation is running
IRecipeDefinition3 (ITF) ¶ INTERFACE IRecipeDefinition3 EXTENDS IRecipeDefinition2 Methods: GetRecipeValuesSizeOf GetRecipeVariableCount , inherited from IRecipeDefinition2 GetRecipeVariableName , inherited from IRecipeDefinition2 Structure: GetRecipeValuesSizeOf (Method)
IRecipeDefinition3.GetRecipeValuesSizeOf (METH) ¶ METHOD GetRecipeValuesSizeOf : DWORD Possible last error values: ERR_NO_RECIPE_MANAGER_SET, ERR_RECIPE_DEFINITION_NOT_FOUND, ERR_RECIPE_NOT_FOUND, ERR_FAILED, ERR_OK InOut: Scope Name Type Comment Return GetRecipeValuesSizeOf DWORD Input pStrings POINTER TO ARRAY [0..0] OF STRING The strings where the recipe values should be stored iSize INT Size of the string array. iStartIndex INT Start index. Can be used for a scroll function (See example) iSizeOfString INT Size of one string in the pStrings array
RDT_Client.Create (METH) ¶ METHOD Create : IRdtProtClient It creates and initializes the object Client InOut: Scope Name Type Comment Return Create IRdtProtClient Input pStruIni POINTER TO RdtInitStructClientTCP Parameters to use Output error INT
RecipeManCommands (FB) ¶ FUNCTION_BLOCK RecipeManCommands The methods of the RecipeManCommands function block allow the programmatic management of recipes. Note The application creates recipe files automatically on the PLC with the names <recipe>.<recipe definition>.txtrecipe . These are used as a buffer when reading and writing recipe variables. The “Save recipe changes to recipe files automatically” option in the Recipe Manager - “General” tab affects access to these files. When the recipe command is called, the application accesses the recipe files internally. This can take a few milliseconds depending on the device type. The calls are not executed in a task with time monitoring or in a predefined time frame (real-time sensitive). Note If the “Save recipe changes to recipe files automatically” option is activated, then the recipes of the definition in CODESYS and the implicit recipe files on the PLC are kept the same automatically. Changing recipes also leads to file access. Deactivate this option if the application controls the saving of files programmatically. Refer to the sample project “Recipe Management” in CODESYS Store for more information about this topic. Methods: CreateRecipe CreateRecipeNoSave DeleteRecipe DeleteRecipeFile GetLastError GetLastInfo GetRecipeCount GetRecipeNames GetRecipeValues GetRecipeValuesSizeOf GetRecipeVariableNames LoadAndWriteRecipe LoadFromAndWriteRecipe LoadRecipe ReadAndSaveAs ReadAndSaveRecipe ReadAndSaveRecipeAs ReadRecipe RegisterDatasourceRecipeDefinition ReloadRecipes ResetLastError ResetLastInfo SaveRecipe SetRecipeValues SetStoragePath WriteRecipe prvCompareRecipe Structure: CreateRecipe (Method) CreateRecipeNoSave (Method) DeleteRecipe (Method) DeleteRecipeFile (Method) GetLastError (Method) GetLastInfo (Method) GetRecipeCount (Method) GetRecipeNames (Method) GetRecipeValues (Method) GetRecipeValuesSizeOf (Method) GetRecipeVariableNames (Method) LoadAndWriteRecipe (Method) LoadFromAndWriteRecipe (Method) LoadRecipe (Method) Private prvCompareRecipe (Method) ReadAndSaveAs (Method) ReadAndSaveRecipe (Method) ReadAndSaveRecipeAs (Method) ReadRecipe (Method) RegisterDatasourceRecipeDefinition (Method) ReloadRecipes (Method) ResetLastError (Method) ResetLastInfo (Method) SaveRecipe (Method) SetRecipeValues (Method) SetStoragePath (Method) WriteRecipe (Method)
RDT_Client.CyclicCall (METH) ¶ METHOD CyclicCall Client cyclic call
RecipeManCommands.CreateRecipe (METH) ¶ METHOD CreateRecipe : DWORD Creates a new recipe in the given recipe definition The method reads the current PLC values to the new recipe and saves them as a recipe file with the default name. The default name is <recipe>.<recipe definition>.<recipe extension> . At the end the new recipe would be stored in the default file. InOut: Scope Name Type Comment Return CreateRecipe DWORD Possible last error values: ERR_RECIPE_DEFINITION_NOT_FOUND ERR_RECIPE_ALREADY_EXIST ERR_RECIPE_NOMEMORY ERR_NO_RECIPE_MANAGER_SET ERR_OK See ReturnValues (GVL) for a description of all possible errors. Inout Const RecipeDefinitionName STRING Name of the recipe definition RecipeName STRING Name of the recipe
RecipeManCommands.CreateRecipeNoSave (METH) ¶ METHOD CreateRecipeNoSave : DWORD Creates a new recipe in the specified recipe definition and afterwared reads the current PLC values into the new recipe InOut: Scope Name Type Comment Return CreateRecipeNoSave DWORD Possible last error values: ERR_RECIPE_DEFINITION_NOT_FOUND ERR_RECIPE_ALREADY_EXIST ERR_RECIPE_NOMEMORY ERR_NO_RECIPE_MANAGER_SET ERR_OK See ReturnValues (GVL) for a description of all possible errors. Inout Const RecipeDefinitionName STRING Name of the recipe definition RecipeName STRING Name of the recipe
RDT_Client.Enable (PROP) ¶ PROPERTY Enable : BOOL