Utilities ¶ RecipeManWStringToString (Function) RecipeMan_FctTypeClassToDataType (Function)

RecipeManWStringToString (FUN) ¶ FUNCTION RecipeManWStringToString : BOOL InOut: Scope Name Type Return RecipeManWStringToString BOOL Input pwStringFrom POINTER TO WSTRING pStringTo POINTER TO STRING

RecipeMan_FctTypeClassToDataType (FUN) ¶ FUNCTION RecipeMan_FctTypeClassToDataType : IEC_DataType InOut: Scope Name Type Return RecipeMan_FctTypeClassToDataType IEC_DataType Input tc TypeClass

File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 17.04.2024, 11:14:54 companyName string 3S-Smart Software Solutions GmbH libraryFile Recipe Management.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 3 contentFile Recipe Management.clean.json version version 2.0.0.0 ProjectInformation OnlineHelp bool True Released True LastModificationDateTime date 17.04.2024, 11:14:49 LibraryCategories library-category-list Intern|RecipeManagement Author string CODESYS Development GmbH Company System CompiledLibraryCompatibilityVersion CODESYS V3.5 SP16 Description See: Description DocFormat reStructuredText DocLanguages en, de Placeholder RecipeManagement Project Recipe Management Title Recipe Management Version version 4.4.0.0

Library Reference ¶ This is a dictionary of all referenced libraries and their name spaces. Base Interfaces ¶ Library Identification ¶ Name: Base Interfaces Version: newest Company: System Namespace: IBaseLibrary Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: Base Interfaces, * (System) CmpErrors2 Interfaces ¶ Library Identification ¶ Name: CmpErrors2 Interfaces Version: newest Company: System Namespace: CmpErrors Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpErrors2 Interfaces, * (System) CmpIecTask ¶ Library Identification ¶ Placeholder: CmpIecTask Default Resolution: CmpIecTask, * (System) Namespace: CmpIecTask Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpIecTask CmpLog ¶ Library Identification ¶ Placeholder: CmpLog Default Resolution: CmpLog, * (System) Namespace: CmpLog Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpLog Collections ¶ Library Identification ¶ Placeholder: Collections Default Resolution: Collections, * (System) Namespace: Collections Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: Collections Datasources Interfaces ¶ Library Identification ¶ Name: Datasources Interfaces Version: newest Company: 3S - Smart Software Solutions GmbH Namespace: IDatasources Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: Datasources Interfaces, * (3S - Smart Software Solutions GmbH) FloatingPointUtils ¶ Library Identification ¶ Placeholder: FloatingPointUtils Default Resolution: FloatingPointUtils, * (System) Namespace: FPU Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: FloatingPointUtils Standard ¶ Library Identification ¶ Placeholder: Standard Default Resolution: Standard, * (System) Namespace: Standard Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: Standard StringUtils ¶ Library Identification ¶ Placeholder: StringUtils Default Resolution: StringUtils, * (System) Namespace: Stu Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: StringUtils SysDir ¶ Library Identification ¶ Placeholder: SysDir Default Resolution: SysDir, * (System) Namespace: SysDir Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysDir SysFile ¶ Library Identification ¶ Placeholder: SysFile Default Resolution: SysFile, * (System) Namespace: SysFile Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysFile SysMem ¶ Library Identification ¶ Placeholder: SysMem Default Resolution: SysMem, * (System) Namespace: SysMem Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysMem SysSem ¶ Library Identification ¶ Placeholder: SysSem Default Resolution: SysSem, * (System) Namespace: SysSem Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysSem SysTypes2 Interfaces ¶ Library Identification ¶ Name: SysTypes2 Interfaces Version: newest Company: System Namespace: SysTypes Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: SysTypes2 Interfaces, * (System) TextListUtils ¶ Library Identification ¶ Placeholder: TextListUtils Default Resolution: TextListUtils, * (System) Namespace: TLU Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: TextListUtils Visu Interfaces ¶ Library Identification ¶ Name: Visu Interfaces Version: newest Company: System Namespace: Visu_Interfaces Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: Visu Interfaces, * (System) Visu Utils ¶ Library Identification ¶ Placeholder: VisuUtils Default Resolution: Visu Utils, * (System) Namespace: VU Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: True SystemLibrary: False Key: VisuUtils

IRecipeDefinition2.GetRecipeVariableCount (METH) ¶ METHOD GetRecipeVariableCount : DINT Returns the number of recipe variables in the current recipe InOut: Scope Name Type Return GetRecipeVariableCount DINT

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

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

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)