Function Blocks ¶ INI_Get (FunctionBlock) INI_Reader (FunctionBlock) CleanUp (Method) Close (Method) INI_Writer (FunctionBlock) Close (Method) Ini_EntryManager (FunctionBlock) AddEntry (Method) DeleteEntry (Method) DeleteEntryAtIndex (Method) IniFileEntryAddress (Property) InifileEntryCount (Property) InsertEntryAtIndex (Method) ModifyEntry (Method) ModifyEntryAtIndex (Method)
INI_Get (FB) ¶ FUNCTION_BLOCK INI_Get EXTENDS CBM.ETrig Function block to find a value by section and key. InOut: Scope Name Type Comment Inherited from Input xExecute BOOL Rising edge: Action starts Falling edge: Resets outputs If a falling edge occurs before the function block has completed its action, the outputs operate in the usual manner and are only reset if either the action is completed or in the event of an error. In this case, the corresponding output values ( xDone , xError ) are present at the outputs for exactly one cycle. ETrig Output xDone BOOL TRUE : Action successfully completed ETrig xBusy BOOL TRUE : Function block active ETrig xError BOOL TRUE : Error occurred, function block aborts action FALSE : No error ETrig Input sSection STRING(100) Name of the section in the INI file. Set ‘’ if no section is used. sKey STRING(100) Key of the entry paIniFileEntry POINTER TO IniFileEntry Pointer to an array of IniFileEntry uiSizeIniFileEntry UINT Maximum size of paIniFileEntry Output eError ERROR Error sValue STRING(255) The search rersult
INI_Reader (FB) ¶ FUNCTION_BLOCK INI_Reader EXTENDS CBM.ETrig Function block to read an INI file. InOut: Scope Name Type Initial Comment Inherited from Input xExecute BOOL Rising edge: Action starts Falling edge: Resets outputs If a falling edge occurs before the function block has completed its action, the outputs operate in the usual manner and are only reset if either the action is completed or in the event of an error. In this case, the corresponding output values ( xDone , xError ) are present at the outputs for exactly one cycle. ETrig Output xDone BOOL TRUE : Action successfully completed ETrig xBusy BOOL TRUE : Function block active ETrig xError BOOL TRUE : Error occurred, function block aborts action FALSE : No error ETrig Input sFileName STRING(255) Path to the INI file. If the input sFileName is empty, then the content of psBuffer will be parsed directly without open a file. sLineSeparator STRING(2) ‘$R$N’ Line separator, default: ‘$R$N’ paIniFileEntry POINTER TO IniFileEntry Pointer to an array of IniFileEntrys uiSizeIniFileEntry UINT Maximum size of paResult psBuffer POINTER TO STRING Pointer to the file content as string. The size of the string must match to the maximum size of the INI file. udiBufferSize UDINT 4096 Maximum size of psBuffer. Default 4096 udiReadPosition UDINT 0 The start postion to read the file. default: 0 Output eError ERROR Error udiBytesRead __XWORD Number of read bytes. udiResultSize UDINT Number of entries. Methods: CleanUp Close Structure: CleanUp (Method) Close (Method)
INI_Reader.CleanUp (METH) ¶ METHOD CleanUp Clean up the array of IniFileEntries
INI_Reader.Close (METH) ¶ METHOD Close Close the file
INI_Writer (FB) ¶ FUNCTION_BLOCK INI_Writer EXTENDS CBM.ETrig Function block to write an INI file. InOut: Scope Name Type Initial Comment Inherited from Input xExecute BOOL Rising edge: Action starts Falling edge: Resets outputs If a falling edge occurs before the function block has completed its action, the outputs operate in the usual manner and are only reset if either the action is completed or in the event of an error. In this case, the corresponding output values ( xDone , xError ) are present at the outputs for exactly one cycle. ETrig Output xDone BOOL TRUE : Action successfully completed ETrig xBusy BOOL TRUE : Function block active ETrig xError BOOL TRUE : Error occurred, function block aborts action FALSE : No error ETrig Input sFileName STRING(255) Path to the INI file. If the input sFileName is empty, then the INI data will be written to psBuffer without open a file. sLineSeparator STRING(2) ‘$R$N’ Line separator, default: ‘$R$N’ paIniFileEntry POINTER TO IniFileEntry Pointer to an array of IniFileEntrys uiSizeIniFileEntry UINT Maximum size of paIniFileEntry psBuffer POINTER TO STRING Pointer to the file content as string. The size of the string must match to the maximum size of the INI file. udiBufferSize UDINT 4096 Maximum size of psBuffer. Default 4096 Output eError ERROR Error Methods: Close Structure: Close (Method)
INI_Writer.Close (METH) ¶ METHOD Close
Ini_EntryManager (FB) ¶ FUNCTION_BLOCK Ini_EntryManager Function block to Manipulate Ini File Entries InOut: Scope Name Type Comment Input paIniFileEntry POINTER TO IniFileEntry Pointer to an array of IniFileEntry uiSizeIniFileEntry UINT Maximum size of paIniFileEntry udiIniFileEntryCount UDINT Number of IniFileEntry Output eError Error Error Properties: IniFileEntryAddress InifileEntryCount Methods: AddEntry DeleteEntry DeleteEntryAtIndex InsertEntryAtIndex ModifyEntry ModifyEntryAtIndex Structure: AddEntry (Method) DeleteEntry (Method) DeleteEntryAtIndex (Method) IniFileEntryAddress (Property) InifileEntryCount (Property) InsertEntryAtIndex (Method) ModifyEntry (Method) ModifyEntryAtIndex (Method)
Ini_EntryManager.AddEntry (METH) ¶ METHOD AddEntry : ERROR Add IniFileEntry to end of array InOut: Scope Name Type Comment Return AddEntry ERROR Input strIniFileEntry IniFileEntry IniFileEntry to add
Ini_EntryManager.DeleteEntry (METH) ¶ METHOD DeleteEntry : Error Delete IniFileEntry by Section and Key InOut: Scope Name Type Comment Return DeleteEntry Error Input strIniFileEntry IniFileEntry Entry to be deleted