CmpEventMgr Interfaces Library Documentation ¶ Company System Title CmpEventMgr Interfaces Version 3.5.17.0 Categories System|SysLibs Author CODESYS Development GmbH Description 1 ¶ This library provides access to the event manager of the runtime system. The event manager handles events from components (provider) and transmits these events via callbacks to IEC consumers (functions or function-blocks). Contents: ¶ Constants (GVL) EventClass (GVL) EventParam (Struct) EventParam2 (Struct) ICmpEventCallback (Interface) EventCallback (Method) Indices and tables ¶ 1 Based on CmpEventMgr_Itfs.library, last modified 20.04.2021, 15:40:36. LibDoc 4.4.0.0-b.27 The content file CmpEventMgr_Itfs.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 20.04.2021, 15:40:36.
EventClass (GVL) ¶ Event class InOut: Scope Name Type Initial Comment Constant EVTCLASS_NONE UINT 0 No class OR invalid EVTCLASS_ALL UINT 16#FFFF All classes EVTCLASS_INFO UINT 16#1 Information EVTCLASS_WARNING UINT 16#2 Warning EVTCLASS_ERROR UINT 16#4 Error EVTCLASS_EXCEPTION UINT 16#8 Exception EVTCLASS_VENDOR_SPEC UINT 16#1000 Vendor specific. Can be used for own event classes
Constants (GVL) ¶ InOut: Scope Name Type Initial Comment Constant EVENT_CALLBACKS_NO_LIMIT UDINT 16#FFFFFFFF No limit of callbacks possible per event CMPID_CmpEventMgr UDINT 16#5B ITFID_ICmpEventCallback UDINT 16#25
EventParam (STRUCT) ¶ TYPE EventParam : 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)
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
Library Reference ¶ This is a dictionary of all referenced libraries and their name spaces. CmpErrors2 Interfaces ¶ Library Identification ¶ Name: CmpErrors2 Interfaces Version: newest Company: System Namespace: CmpErrors Library Properties ¶ LinkAllContent: False Optional: False QualifiedOnly: False SystemLibrary: False Key: CmpErrors2 Interfaces, * (System) 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)
CIFX_BOARD (STRUCT) ¶ TYPE CIFX_BOARD : STRUCT InOut: Name Type tBoardInfo CIFX_BOARD_INFORMATION aChannel ARRAY [0..(CIFX_MAX_CHANNELS_OF_ONE_BOARD - 1)] OF CIFX_CHANNEL