CmpEventMgr Implementation Library Documentation ¶ Company System Title CmpEventMgr Implementation Version 3.5.17.0 Categories System|SysLibs Author CODESYS Development GmbH Placeholder CmpEventMgr Implementation 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: ¶ EventClose2 (Function) EventCreate (Function) EventCreate2 (Function) EventCreateEventID (Function) EventDelete2 (Function) EventGetClass (Function) EventGetEvent (Function) EventOpen (Function) EventPost (Function) EventPost2 (Function) EventPostByEvent (Function) EventPostByEvent2 (Function) EventRegisterCallback (Function) EventRegisterCallback2 (Function) EventRegisterCallbackFunction (Function) EventRegisterCallbackFunction2 (Function) EventRegisteredCallbacks (Function) EventUnregisterCallback (Function) EventUnregisterCallbackFunction (Function) EventUnregisterCallbackFunction2 (Function) Indices and tables ¶ 1 Based on CmpEventMgr Implementation.library, last modified 20.04.2021, 15:40:14. LibDoc 4.4.0.0-b.27 The content file CmpEventMgr Implementation.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 20.04.2021, 15:40:15.
EventClose2 (FUN) ¶ FUNCTION EventClose2 : RTS_IEC_RESULT Close an event specified by handle InOut: Scope Name Type Comment Return EventClose2 RTS_IEC_RESULT Input hEvent RTS_IEC_HANDLE Event handle
EventCreate (FUN) ¶ FUNCTION EventCreate : RTS_IEC_HANDLE Creates a new event object. If event still exists, a handle to this object will be returned. An IEC event is typically created by the provider in FB_Init of a function block InOut: Scope Name Type Comment Return EventCreate RTS_IEC_HANDLE Input EventId UDINT Event ID of the event. Contains the class and the event CmpIdProvider UDINT Component ID of the provider Inout Result RTS_IEC_RESULT Error code
EventCreate2 (FUN) ¶ FUNCTION EventCreate2 : RTS_IEC_HANDLE Creates a new event object. If event still exists, a handle to this object will be returned. An IEC event is typically created by the provider in FB_Init of a function block InOut: Scope Name Type Comment Return EventCreate2 RTS_IEC_HANDLE Input EventId UDINT Event ID of the event. Contains the class and the event CmpIdProvider UDINT Component ID of the provider nCallbacksPossible UDINT Maximum number of callbacks possible on this event or EVENT_CALLBACKS_NO_LIMIT for no limit Inout Result RTS_IEC_RESULT Error code
EventCreateEventID (FUN) ¶ FUNCTION EventCreateEventID : UDINT Create your own EventID InOut: Scope Name Type Comment Return EventCreateEventID UDINT Input Event UINT Event Class UINT Class, see classes in EventClass Inout Result RTS_IEC_RESULT Error code
EventDelete2 (FUN) ¶ FUNCTION EventDelete2 : RTS_IEC_RESULT Deletes an event specified by handle. InOut: Scope Name Type Comment Return EventDelete2 RTS_IEC_RESULT Input hEvent RTS_IEC_HANDLE Event handle
EventGetClass (FUN) ¶ FUNCTION EventGetClass : UINT Extract the event class from eventid. Return value is the event class InOut: Scope Name Type Comment Return EventGetClass UINT Input EventId UDINT Event id
EventGetEvent (FUN) ¶ FUNCTION EventGetEvent : UINT Extract the event from eventid. Return value ist the event InOut: Scope Name Type Comment Return EventGetEvent UINT Input EventId UDINT Event ID
EventOpen (FUN) ¶ FUNCTION EventOpen : RTS_IEC_HANDLE Opens an existing event object. Can be used to check, if the event was created by the provider. If the event does not exist, an error code is returned. InOut: Scope Name Type Comment Return EventOpen RTS_IEC_HANDLE Input EventId UDINT EventID of the event. Contains the class and the event CmpIdProvider UDINT Component ID of the provider Inout Result RTS_IEC_RESULT Error code
EventPost (FUN) ¶ FUNCTION EventPost : RTS_IEC_RESULT Post or sent an event InOut: Scope Name Type Comment Return EventPost RTS_IEC_RESULT Input hEvent RTS_IEC_HANDLE Event handle pEventParam POINTER TO EventParam Pointer to the event parameters