SchedPostExternalEvent (FUN) ¶ FUNCTION SchedPostExternalEvent : RTS_IEC_RESULT <description> <p>Execute all tasks, that are registered for the given event. The execution context may vary depending on the scheduler type. It might be executed synchronously in the context of the caller, or a system task (e.g. ontop of an OS) is just signaled to execute the task code.</p> <p>Note, that the result ERR_NO_OBJECT might not be a real error. Depending on the system it might be OK, that no task was registered for this event.</p> </description> <param name=”hExtEvent” type=”IN”>Handle to the external event, which tasks should be signaled</param> <errorcode name=”RTS_IEC_RESULT” type=”ERR_OK”>Event was signaled successfully</errorcode> <errorcode name=”RTS_IEC_RESULT” type=”ERR_PARAMETER”>The event handle was not found</errorcode> <errorcode name=”RTS_IEC_RESULT” type=”ERR_NO_OBJECT”>There was no task, registered on this event</errorcode> <result>Error Code</result> InOut: Scope Name Type Return SchedPostExternalEvent RTS_IEC_RESULT Input hExtEvent RTS_IEC_HANDLE
SchedRegisterExternalEvent (FUN) ¶ FUNCTION SchedRegisterExternalEvent : RTS_IEC_HANDLE <description> <p>Register an external event, which might be used later by event tasks. You should register those events during the system startup, so that the scheduler knows all events when the application is loaded.</p> <p>Valid Hook: CH_INIT2</p> <p>Note: the parameter pszExtEventName needs to be constantly allocated. It might either be a constant string, a global string variable, or a dynamically allocated string. But the memory needs to be valid during the life time of the event handle.</p> </description> <param name=”pszExtEventName” type=”IN”>Name of the event, as it was specified in the device description. This parameter needs to be constantly allocated</param> <param name=”pResult” type=”INOUT”>Error Code</param> <errorcode name=”RTS_IEC_RESULT” type=”ERR_OK”>Event was registered successfully</errorcode> <errorcode name=”RTS_IEC_RESULT” type=”ERR_NOMEMORY”>There was not enough memory to register the new event handle</errorcode> <result>handle to the event</result> InOut: Scope Name Type Return SchedRegisterExternalEvent RTS_IEC_HANDLE Input pszExtEventName REFERENCE TO STRING pResult POINTER TO RTS_IEC_RESULT
SchedSetTaskInterval (FUN) ¶ FUNCTION SchedSetTaskInterval : RTS_IEC_RESULT <description> Set the actual interval of a cyclic task. If the specified task is no cyclic task, the function return an error. This interface can be used to synchronize a task to another task or to events. </description> <param name=”hSchedTask” type=”IN”>Handle to the task</param> <param name=”tInterval” type=”IN”>New interval in microseconds!</param> <result>error code</result> InOut: Scope Name Type Return SchedSetTaskInterval RTS_IEC_RESULT Input hSchedTask RTS_IEC_HANDLE ulInterval UDINT
SchedUnregisterExternalEvent (FUN) ¶ FUNCTION SchedUnregisterExternalEvent : RTS_IEC_RESULT <description> <p>Unregister an external event, which was registered by SchedRegisterExternalEvent() before.</p> <p>This function should be called on system shutdown</p> <p>Valid Hook: CH_EXIT2</p> </description> <param name=”hExtEvent” type=”IN”>Handle to the external event, that should be unregistered.</param> <errorcode name=”RTS_IEC_RESULT” type=”ERR_OK”>Event was deregistered successfully</errorcode> <errorcode name=”RTS_IEC_RESULT” type=”ERR_PARAMETER”>The event handle was not registered before</errorcode> <result>Error code</result> InOut: Scope Name Type Return SchedUnregisterExternalEvent RTS_IEC_RESULT Input hExtEvent RTS_IEC_HANDLE
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
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