CmpSettings Library Documentation ¶ Company System Title CmpSettings Version 3.5.17.0 Categories System|SysLibs Author 3S - Smart Software Solutions GmbH Placeholder CmpSettings Description 1 ¶ Library to access all configuration settings. Contents: ¶ SettgBeginUpdate (Function) SettgCacheOptions (GVL) SettgEndUpdate (Function) SettgGetIntValue (Function) SettgGetStringValue (Function) SettgGetWStringValue (Function) SettgRemoveKey (Function) SettgSetIntValue (Function) SettgSetStringValue (Function) SettgSetWStringValue (Function) Indices and tables ¶ 1 Based on CmpSettings.library, last modified 20.04.2021, 15:55:36. LibDoc 4.4.0.0-b.27 The content file CmpSettings.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 20.04.2021, 15:55:36.

SettgCacheOptions (GVL) ¶ Options of the parameter bCached InOut: Scope Name Type Initial Comment Constant CMPSETTINGS_CACHED DINT 0 Value is read from cache (default) CMPSETTINGS_NOT_CACHED DINT 1 Value is read from file and cache is updated for all values

SettgBeginUpdate (FUN) ¶ FUNCTION SettgBeginUpdate : RTS_IEC_RESULT Function to block writing settings to database file until SettgEndUpdate is called! But the settings cache is updated. NOTE: - Funcion can be called nested, so only at the last call of SettgEndUpdate , the database is written! - Always call SettgBeginUpdate() and SettgEndUpdate() symmetric!!! InOut: Scope Name Type Comment Return SettgBeginUpdate RTS_IEC_RESULT Runtime system error code (see CmpErrors.library).

SettgEndUpdate (FUN) ¶ FUNCTION SettgEndUpdate : RTS_IEC_RESULT Function to initiate writing settings to database file, if settings are modified after SettgBeginUpdate was called. NOTE: - Funcion can be called nested, so only at the last call of SettgEndUpdate , the database is written! - Always call SettgBeginUpdate and SettgEndUpdate symmetric!!! InOut: Scope Name Type Comment Return SettgEndUpdate RTS_IEC_RESULT Runtime system error code (see CmpErrors.library).

SettgGetIntValue (FUN) ¶ FUNCTION SettgGetIntValue : RTS_IEC_RESULT Get an integer value from settings InOut: Scope Name Type Comment Return SettgGetIntValue RTS_IEC_RESULT Runtime system error code (see CmpErrors.library). Input pszComponent REFERENCE TO STRING Name of component pszKey REFERENCE TO STRING Name of key piValue POINTER TO DINT Pointer to value for result iDefault DINT Default value to set, if key not found bCached DINT Flag, if value should be read cached or direct from file (CMPSETTINGS_CACHED, CMPSETTINGS_NOT_CACHED)

SettgGetStringValue (FUN) ¶ FUNCTION SettgGetStringValue : RTS_IEC_RESULT Get a string value from settings InOut: Scope Name Type Comment Return SettgGetStringValue RTS_IEC_RESULT Runtime system error code (see CmpErrors.library). Input pszComponent REFERENCE TO STRING Name of component pszKey REFERENCE TO STRING Name of key pszValue POINTER TO STRING Pointer to value for result piLen POINTER TO DINT Max length of string value pszDefault REFERENCE TO STRING Default value to set, if key not found bCached DINT Flag, if value should be read cached or direct from file (CMPSETTINGS_CACHED, CMPSETTINGS_NOT_CACHED)

SettgGetWStringValue (FUN) ¶ FUNCTION SettgGetWStringValue : RTS_IEC_RESULT Get a WSTRING value from settings InOut: Scope Name Type Comment Return SettgGetWStringValue RTS_IEC_RESULT Runtime system error code (see CmpErrors.library). Input pszComponent REFERENCE TO STRING Name of component pszKey REFERENCE TO STRING Name of key pwszValue POINTER TO WSTRING Pointer to value for result piLen POINTER TO DINT Max length of string in WSTRING characters (not bytes!) pwszDefault REFERENCE TO WSTRING Default value to set, if key not found bCached DINT Flag, if value should be read cached or direct from file (CMPSETTINGS_CACHED, CMPSETTINGS_NOT_CACHED)

SettgRemoveKey (FUN) ¶ FUNCTION SettgRemoveKey : RTS_IEC_RESULT Remove the specified key InOut: Scope Name Type Comment Return SettgRemoveKey RTS_IEC_RESULT Runtime system error code (see CmpErrors.library). Input pszComponent REFERENCE TO STRING Name of component pszKey REFERENCE TO STRING Name of key

SettgSetIntValue (FUN) ¶ FUNCTION SettgSetIntValue : RTS_IEC_RESULT Write an integer value to settings InOut: Scope Name Type Initial Comment Return SettgSetIntValue RTS_IEC_RESULT Runtime system error code (see CmpErrors.library). Input pszComponent REFERENCE TO STRING Name of component pszKey REFERENCE TO STRING Name of key iValue DINT Value to write iBase DINT 10 2=Base 2, 10=Decimal values, 16=Hex values

SettgSetStringValue (FUN) ¶ FUNCTION SettgSetStringValue : RTS_IEC_RESULT Write a string value to settings InOut: Scope Name Type Comment Return SettgSetStringValue RTS_IEC_RESULT Runtime system error code (see CmpErrors.library). Input pszComponent REFERENCE TO STRING Name of component pszKey REFERENCE TO STRING Name of key pszValue REFERENCE TO STRING Pointer to write value iLen DINT Length of string to write