EventParam2 (STRUCT) ¶ TYPE EventParam2 : STRUCT InOut: Name Type Comment EventId DWORD EventID of the event. Contains the class and the event CmpIdProvider DWORD Component ID of the provider. usParamId WORD Id of the parameter structure (see pParameter) usVersion WORD Version of the parameter structure (see pParameter) pParameter POINTER TO BYTE Pointer to the event specific parameter, that is specified by Id (see usParamId) pUserParameter POINTER TO BYTE Pointer to the user specific parameter, that can be specified by registering the callback
ICmpEventCallback (ITF) ¶ INTERFACE ICmpEventCallback A function block must implement this interface to register the EventCallback method for an event. The interface can be registered on a event using the function EventRegisterCallback or EventRegisterCallback2 Methods: EventCallback Structure: EventCallback (Method)
ICmpEventCallback.EventCallback (METH) ¶ METHOD EventCallback : RTS_IEC_RESULT The interface ICmpEventCallback must be registered for an event. If this event is posted, this callback method is called. InOut: Scope Name Type Comment Return EventCallback RTS_IEC_RESULT Input pEventParam POINTER TO EventParam Pointer to the event parameters, see Struct EventParam
File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 20.04.2021, 15:40:36 companyName string 3S-Smart Software Solutions GmbH libraryFile CmpEventMgr_Itfs.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 3 contentFile CmpEventMgr_Itfs.clean.json version version 2.0.0.0 ProjectInformation IsInterfaceLibrary bool True Released True SourceLibrary False LastModificationDateTime date 20.04.2021, 15:40:36 LibraryCategories library-category-list System|SysLibs Author string CODESYS Development GmbH Company System CompiledLibraryCompatibilityVersion CODESYS V3.5 SP15 Patch 2 DefaultNamespace Description See: Description DocFormat reStructuredText Project CmpEventMgr_Itfs Title CmpEventMgr Interfaces Version version 3.5.17.0
EventRegisterCallbackFunction2 (FUN) ¶ FUNCTION EventRegisterCallbackFunction2 : RTS_IEC_RESULT Register a callback function to an event. Callback is the address of an Iec function: ADR(function) InOut: Scope Name Type Comment Return EventRegisterCallbackFunction2 RTS_IEC_RESULT Input hEvent RTS_IEC_HANDLE Handle to event pfCallbackFunction POINTER TO BYTE Address of callback function. Prototype: same as ICmpEventCallback::EventCallback method Function pointer is retrieved by the ADR operator: ADR(function) pUserParameter POINTER TO BYTE Pointer to user parameter, that is transmitted optional to the callback (see EventParam)
EventRegisteredCallbacks (FUN) ¶ FUNCTION EventRegisteredCallbacks : UDINT Returns the number of registered callbacks on the event InOut: Scope Name Type Comment Return EventRegisteredCallbacks UDINT Input hEvent RTS_IEC_HANDLE Event handle Inout Result RTS_IEC_RESULT Error code
EventUnregisterCallback (FUN) ¶ FUNCTION EventUnregisterCallback : RTS_IEC_RESULT Unregister a callback interface from an event specified by handle and callback interface InOut: Scope Name Type Comment Return EventUnregisterCallback RTS_IEC_RESULT Input hEvent RTS_IEC_HANDLE Event handle hInterface RTS_IEC_HANDLE Callback handle is returned by EventRegisterCallback() or EventRegisterCallback2()!!!
EventUnregisterCallbackFunction (FUN) ¶ FUNCTION EventUnregisterCallbackFunction : RTS_IEC_RESULT Unregister a callback function from an event specified by handle and callback InOut: Scope Name Type Comment Return EventUnregisterCallbackFunction RTS_IEC_RESULT Input hEvent RTS_IEC_HANDLE Handle to event pfCallbackFunction POINTER TO BYTE Address of callback function. Function pointer is retrieved by the ADR operator: ADR(function)
EventUnregisterCallbackFunction2 (FUN) ¶ FUNCTION EventUnregisterCallbackFunction2 : RTS_IEC_RESULT Unregister a callback function with a specific user parameter from an event specified by handle and callback and parameter InOut: Scope Name Type Comment Return EventUnregisterCallbackFunction2 RTS_IEC_RESULT Input hEvent RTS_IEC_HANDLE Handle to event pfCallbackFunction POINTER TO BYTE Address of callback function. Function pointer is retrieved by the ADR operator: ADR(function) pUserParameter POINTER TO BYTE Pointer to user parameter, that was specified as a parameter at EventRegisterCallback2()
File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 20.04.2021, 15:40:15 companyName string 3S-Smart Software Solutions GmbH libraryFile CmpEventMgr Implementation.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 3 contentFile CmpEventMgr Implementation.clean.json version version 2.0.0.0 ProjectInformation IsEndUserLibrary bool False LinkInSimulation True Released True LastModificationDateTime date 20.04.2021, 15:40:14 LibraryCategories library-category-list System|SysLibs Author string CODESYS Development GmbH Company System CompiledLibraryCompatibilityVersion CODESYS V3.5 SP15 Patch 2 DefaultNamespace Description See: Description DocFormat reStructuredText Placeholder CmpEventMgr Implementation Project CmpEventMgr Implementation Title CmpEventMgr Implementation Version version 3.5.17.0