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)
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
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
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
SettgSetWStringValue (FUN) ¶ FUNCTION SettgSetWStringValue : UDINT Write a WSTRING value to settings InOut: Scope Name Type Comment Return SettgSetWStringValue UDINT Runtime system error code (see CmpErrors.library). Input pszComponent REFERENCE TO STRING Name of component pszKey REFERENCE TO STRING Name of key pwszValue REFERENCE TO WSTRING Pointer to write value iLen DINT Length of string in WSTRING characters (not bytes!) to write
File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 20.04.2021, 15:55:36 companyName string 3S-Smart Software Solutions GmbH libraryFile CmpSettings.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 3 contentFile CmpSettings.clean.json version version 2.0.0.0 ProjectInformation Released bool True LastModificationDateTime date 20.04.2021, 15:55:36 LibraryCategories library-category-list System|SysLibs Author string 3S - Smart Software Solutions GmbH Company System CompiledLibraryCompatibilityVersion CODESYS V3.5 SP15 Description See: Description DocFormat reStructuredText Placeholder CmpSettings Project CmpSettings Title CmpSettings Version version 3.5.17.0
Library Reference ¶ This is a dictionary of all referenced libraries and their name spaces. 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)
