EventIDs (GVL)

InOut:

Scope

Name

Type

Initial

Comment

Constant

CMPID_CmpApp

DWORD

16#2

ComponentID to specify for EventOpen

EVTPARAMID_CmpApp

WORD

16#1

IDs for the event parameter structures

EVTVERSION_CmpApp

WORD

16#1

EVTPARAMID_CmpAppConfig

WORD

16#1

EVTVERSION_CmpAppConfig

WORD

16#1

EVTPARAMID_CmpAppReset

WORD

16#1

EVTVERSION_CmpAppReset

WORD

16#2

EVTPARAMID_CmpAppStop

WORD

16#2

EVTVERSION_CmpAppStop

WORD

16#1

EVTPARAMID_CmpAppExit

WORD

16#1

EVTVERSION_CmpAppExit

WORD

16#2

EVTPARAMID_CmpAppDenyStart

WORD

16#3

EVTVERSION_CmpAppDenyStart

WORD

16#1

EVTPARAMID_CmpAppDenyStop

WORD

16#4

EVTVERSION_CmpAppDenyStop

WORD

16#1

EVTPARAMID_CmpAppAllBootAppsLoaded

WORD

16#5

EVTVERSION_CmpAppAllBootAppsLoaded

WORD

16#1

EVTPARAMID_CmpAppDenyLoadBootproject

WORD

16#6

EVTVERSION_CmpAppDenyLoadBootproject

WORD

16#1

EVTPARAMID_CmpAppPrepareLoadBootproject

WORD

16#7

EVTVERSION_CmpAppPrepareLoadBootproject

WORD

16#1

EVTPARAMID_CmpAppException

WORD

16#8

EVTVERSION_CmpAppException

WORD

16#1

EVTPARAMID_CmpAppRegisterBootproject

WORD

16#9

EVTVERSION_CmpAppRegisterBootproject

WORD

16#1

EVTPARAMID_CmpAppOperatingStateChanged

WORD

16#A

EVTVERSION_CmpAppOperatingStateChanged

WORD

16#1

EVTPARAMID_CmpAppSourceDownload

WORD

16#B

EVTVERSION_CmpAppSourceDownload

WORD

16#1

EVTPARAMID_CmpAppComm

WORD

16#C

EVTVERSION_CmpAppComm

WORD

16#2

EVTPARAMID_CmpAppDeny

WORD

16#D

EVTVERSION_CmpAppDeny

WORD

16#1

EVTPARAMID_CmpAppDenyDelete

WORD

16#E

EVTVERSION_CmpAppDenyDelete

WORD

16#1

EVTPARAMID_CmpAppOEMServiceTag

WORD

16#F

EVTVERSION_CmpAppOEMServiceTag

WORD

16#1

EVTPARAMID_CmpAppCommCycle

WORD

16#17

EVTVERSION_CmpAppCommCycle

WORD

16#1

EVTPARAMID_CmpAppStateChanged

WORD

16#18

EVTVERSION_CmpAppStateChanged

WORD

16#1

EVTPARAMID_CmpAppRetainBackupState

WORD

16#1B

EVTVERSION_CmpAppRetainBackupState

WORD

16#1

EVTPARAMID_CmpAppResetAllApplications

WORD

16#1C

EVTVERSION_CmpAppResetAllApplications

WORD

16#1

APP_STOP_REASON_UNKNOWN

DWORD

0

    • <category>Stop reason</category>

    • <description>

    • Reason to set the application in stop.

    • </description>

    • <element name=”APP_STOP_REASON_UNKNOWN” type=”IN”>Unknown reason</element>

    • <element name=”APP_STOP_REASON_SHUTDOWN” type=”IN”>Shutdown of the plc</element>

    • <element name=”APP_STOP_REASON_RESET” type=”IN”>Reset will be done after stop the application</element>

    • <element name=”APP_STOP_REASON_EXCEPTION” type=”IN”>Exception occurred</element>

    • <element name=”APP_STOP_REASON_USER” type=”IN”>User stopped the application</element>

    • <element name=”APP_STOP_REASON_IECPROGRAM” type=”IN”>Stop is done out of the IEC program</element>

    • <element name=”APP_STOP_REASON_DELETE” type=”IN”>Application will be deleted after the stop</element>

APP_STOP_REASON_SHUTDOWN

DWORD

1

APP_STOP_REASON_RESET

DWORD

2

APP_STOP_REASON_EXCEPTION

DWORD

3

APP_STOP_REASON_USER

DWORD

4

APP_STOP_REASON_IECPROGRAM

DWORD

5

APP_STOP_REASON_DELETE

DWORD

6

EVT_PrepareStart

DWORD

(SHL(UINT_TO_DWORD(EventClass.EVTCLASS_INFO), 16) OR 16#1)

    • <category>Events</category>

    • <description>Event is sent before start of the specified application</description>

    • <param name=”pEventParam” type=”IN”>EVTPARAM_CmpApp</param>

EVT_StartDone

DWORD

(SHL(UINT_TO_DWORD(EventClass.EVTCLASS_INFO), 16) OR 16#2)

    • <category>Events</category>

    • <description>Event is sent after start of the specified application</description>

    • <param name=”pEventParam” type=”IN”>EVTPARAM_CmpApp</param>

EVT_PrepareStop

DWORD

(SHL(UINT_TO_DWORD(EventClass.EVTCLASS_INFO), 16) OR 16#3)

    • <category>Events</category>

    • <description>Event is sent before stop of the specified application</description>

    • <param name=”pEventParam” type=”IN”>EVTPARAM_CmpAppStop</param>

EVT_StopDone

DWORD

(SHL(UINT_TO_DWORD(EventClass.EVTCLASS_INFO), 16) OR 16#4)

    • <category>Events</category>

    • <description>Event is sent after stop of the specified application</description>

    • <param name=”pEventParam” type=”IN”>EVTPARAM_CmpAppStop</param>

EVT_PrepareReset

DWORD

(SHL(UINT_TO_DWORD(EventClass.EVTCLASS_INFO), 16) OR 16#5)

    • <category>Events</category>

    • <description>Event is sent before reset of the specified application</description>

    • <param name=”pEventParam” type=”IN”>EVTPARAM_CmpAppReset</param>

EVT_ResetDone

DWORD

(SHL(UINT_TO_DWORD(EventClass.EVTCLASS_INFO), 16) OR 16#6)

    • <category>Events</category>

    • <description>Event is sent after reset of the specified application</description>

    • <param name=”pEventParam” type=”IN”>EVTPARAM_CmpAppReset</param>

EVT_PrepareOnlineChange

DWORD

(SHL(UINT_TO_DWORD(EventClass.EVTCLASS_INFO), 16) OR 16#7)

    • <category>Events</category>

    • <description>Event is sent before online change of the specified application</description>

    • <param name=”pEventParam” type=”IN”>EVTPARAM_CmpApp</param>

EVT_OnlineChangeDone

DWORD

(SHL(UINT_TO_DWORD(EventClass.EVTCLASS_INFO), 16) OR 16#8)

    • <category>Events</category>

    • <description>Event is sent after online change of the specified application</description>

    • <param name=”pEventParam” type=”IN”>EVTPARAM_CmpApp</param>

EVT_PrepareDownload

DWORD

(SHL(UINT_TO_DWORD(EventClass.EVTCLASS_INFO), 16) OR 16#9)

    • <category>Events</category>

    • <description>Event is sent before download of the specified application</description>

    • <param name=”pEventParam” type=”IN”>EVTPARAM_CmpApp</param>

EVT_DownloadDone

DWORD

(SHL(UINT_TO_DWORD(EventClass.EVTCLASS_INFO), 16) OR 16#A)

    • <category>Events</category>

    • <description>Event is sent after download of the specified application</description>

    • <param name=”pEventParam” type=”IN”>EVTPARAM_CmpApp</param>

EVT_CodeInitDone

DWORD

(SHL(UINT_TO_DWORD(EventClass.EVTCLASS_INFO), 16) OR 16#B)

    • <category>Events</category>

    • <description>Event is sent after CodeInit. Is called inside the task safe section

    • and only at online-change! (e.g. the copy code for online-change is executed here).</description>

    • <param name=”pEventParam” type=”IN”>EVTPARAM_CmpApp</param>

EVT_PrepareExit

DWORD

(SHL(UINT_TO_DWORD(EventClass.EVTCLASS_INFO), 16) OR 16#E)

    • <category>Events</category>

    • <description>Event is sent before an application executes its exit code. The application is stopped, if this event is posted.</description>

    • <param name=”pEventParam” type=”IN”>EVTPARAM_CmpAppExit</param>

EVT_CreateBootprojectDone

DWORD

(SHL(UINT_TO_DWORD(EventClass.EVTCLASS_INFO), 16) OR 16#10)

    • <category>Events</category>

    • <description>Event is sent after creating a bootproject of an application successfully</description>

    • <param name=”pEventParam” type=”IN”>EVTPARAM_CmpApp</param>

EVT_DenyLoadBootproject

DWORD

(SHL(UINT_TO_DWORD(EventClass.EVTCLASS_INFO), 16) OR 16#12)

    • <category>Events</category>

    • <description>Event is sent to deny loading a bootproject of an application.

    • </description>

    • <param name=”pEventParam” type=”IN”>EVTPARAM_CmpAppDenyLoadBootproject</param>

EVT_PrepareLoadBootproject

DWORD

(SHL(UINT_TO_DWORD(EventClass.EVTCLASS_INFO), 16) OR 16#13)

    • <category>Events</category>

    • <description>Event is sent before loading a bootproject of an application</description>

    • <param name=”pEventParam” type=”IN”>EVTPARAM_CmpAppPrepareLoadBootproject</param>

EVT_LoadBootprojectDone

DWORD

(SHL(UINT_TO_DWORD(EventClass.EVTCLASS_INFO), 16) OR 16#11)

    • <category>Events</category>

    • <description>Event is sent after loading a bootproject of an application successfully</description>

    • <param name=”pEventParam” type=”IN”>EVTPARAM_CmpApp</param>

EVT_DenyStartBootproject

DWORD

(SHL(UINT_TO_DWORD(EventClass.EVTCLASS_INFO), 16) OR 16#14)

    • <category>Events</category>

    • <description>Event is sent to deny starting a bootproject of an application.

    • </description>

    • <param name=”pEventParam” type=”IN”>EVTPARAM_CmpAppDenyStart</param>

EVT_PrepareStartBootproject

DWORD

(SHL(UINT_TO_DWORD(EventClass.EVTCLASS_INFO), 16) OR 16#15)

    • <category>Events</category>

    • <description>Event is sent before starting a bootproject of an application</description>

    • <param name=”pEventParam” type=”IN”>EVTPARAM_CmpApp</param>

EVT_StartBootprojectDone

DWORD

(SHL(UINT_TO_DWORD(EventClass.EVTCLASS_INFO), 16) OR 16#16)

    • <category>Events</category>

    • <description>Event is sent after starting a bootproject of an application</description>

    • <param name=”pEventParam” type=”IN”>EVTPARAM_CmpApp</param>

EVT_DenyStart

DWORD

(SHL(UINT_TO_DWORD(EventClass.EVTCLASS_INFO), 16) OR 16#17)

    • <category>Events</category>

    • <description>Event is sent to deny starting an application</description>

    • <param name=”pEventParam” type=”IN”>EVTPARAM_CmpAppDenyStart</param>

EVT_DenyStop

DWORD

(SHL(UINT_TO_DWORD(EventClass.EVTCLASS_INFO), 16) OR 16#18)

    • <category>Events</category>

    • <description>Event is sent to deny stopping an application</description>

    • <param name=”pEventParam” type=”IN”>EVTPARAM_CmpAppDenyStop</param>

EVT_AllBootprojectsLoaded

DWORD

(SHL(UINT_TO_DWORD(EventClass.EVTCLASS_INFO), 16) OR 16#19)

    • <category>Events</category>

    • <description>Event is sent after all boot applications have been loaded</description>

    • <param name=”pEventParam” type=”IN”>EVTPARAM_CmpAppAllBootAppsLoaded</param>

EVT_GlobalExitOnResetDone

DWORD

(SHL(UINT_TO_DWORD(EventClass.EVTCLASS_INFO), 16) OR 16#1A)

    • <category>Events</category>

    • <description>Event is sent on Reset, after global exit and before global init.</description>

    • <param name=”pEventParam” type=”IN”>EVTPARAM_CmpAppAllBootAppsLoaded</param>

EVT_ExitDoneWithConfigAppInfo

DWORD

(SHL(UINT_TO_DWORD(EventClass.EVTCLASS_INFO), 16) OR 16#1B)

    • <category>Events</category>

    • <description>Event is sent after an application has executed its exit code. The application is stopped, if this event is posted. The event has got the additional parameter szConfigApp</description>

    • <param name=”pEventParam” type=”IN”>EVTPARAM_CmpAppConfig</param>

EVT_CmpApp_Exception

DWORD

(SHL(UINT_TO_DWORD(EventClass.EVTCLASS_EXCEPTION), 16) OR 16#1C)

    • <category>Events</category>

    • <description>Event is sent, IF an exception occurred in the context OF an application

    • NOTE:

    • In case of a retain mismatch, the RTSEXCPT_RETAIN_IDENTITY_MISMATCH is provided as exception code (see ulException in EVTPARAM_CmpAppException).

    • </description>

    • <param name=”pEventParam” TYPE=”IN”>EVTPARAM_CmpAppException</param>

EVT_RegisterBootproject

DWORD

(SHL(UINT_TO_DWORD(EventClass.EVTCLASS_INFO), 16) OR 16#1D)

    • <category>Events</category>

    • <description>Event is sent, if a new bootproject is registered</description>

    • <param name=”pEventParam” type=”IN”>EVTPARAM_CmpAppRegisterBootproject</param>

EVT_CreateBootprojectFileFailed

DWORD

(SHL(UINT_TO_DWORD(EventClass.EVTCLASS_ERROR), 16) OR 16#1E)

    • <category>Events</category>

    • <description>Event is sent, if the bootproject file cannot be created.

    • NOTE: EVT_CreateBootprojectFailed is sent additionally in this case!</description>

    • <param name=”pEventParam” type=”IN”>EVTPARAM_CmpApp</param>

EVT_CreateBootprojectFailed

DWORD

(SHL(UINT_TO_DWORD(EventClass.EVTCLASS_ERROR), 16) OR 16#1F)

    • <category>Events</category>

    • <description>Event is sent, if the creation of a bootproject failed. This can occur at creation of the bootproject

    • implicit at download or explicit by the user.</description>

    • <param name=”pEventParam” type=”IN”>EVTPARAM_CmpApp</param>

EVT_OperatingStateChanged

DWORD

(SHL(UINT_TO_DWORD(EventClass.EVTCLASS_INFO), 16) OR 16#20)

    • <category>Events</category>

    • <description>Event is sent, if the operating state has changed</description>

    • <param name=”pEventParam” type=”IN”>EVTPARAM_CmpAppOperatingStateChanged</param>

EVT_OperationStateChanged

DWORD

(SHL(UINT_TO_DWORD(EventClass.EVTCLASS_INFO), 16) OR 16#20)

DEPRECATED: This is only for backward compatibility and should not be used!

EVT_SourceDownload

DWORD

(SHL(UINT_TO_DWORD(EventClass.EVTCLASS_INFO), 16) OR 16#21)

    • <category>Events</category>

    • <description>Event is sent, if the project archive is downloaded (source download)</description>

    • <param name=”pEventParam” type=”IN”>EVTPARAM_CmpAppSourceDownload</param>

EVT_Login

DWORD

(SHL(UINT_TO_DWORD(EventClass.EVTCLASS_INFO), 16) OR 16#22)

    • <category>Events</category>

    • <description>Event is sent, if a client login to the specified application</description>

    • <param name=”pEventParam” type=”IN”>EVTPARAM_CmpAppComm</param>

EVT_Logout

DWORD

(SHL(UINT_TO_DWORD(EventClass.EVTCLASS_INFO), 16) OR 16#23)

    • <category>Events</category>

    • <description>Event is sent, if a client logout of the specified application. The event is sent additionally, if a communication error occurred.</description>

    • <param name=”pEventParam” type=”IN”>EVTPARAM_CmpAppComm</param>

EVT_DenyDelete

DWORD

(SHL(UINT_TO_DWORD(EventClass.EVTCLASS_INFO), 16) OR 16#24)

    • <category>Events</category>

    • <description>Event is sent to deny deleting an application</description>

    • <param name=”pEventParam” type=”IN”>EVTPARAM_CmpAppDenyDelete</param>

EVT_DenyDeleteBootproject

DWORD

(SHL(UINT_TO_DWORD(EventClass.EVTCLASS_INFO), 16) OR 16#25)

    • <category>Events</category>

    • <description>Event is sent to deny deleting a bootproject of an application</description>

    • <param name=”pEventParam” type=”IN”>EVTPARAM_CmpAppDenyDelete</param>

EVT_OEMDownloadServiceTag

DWORD

(SHL(UINT_TO_DWORD(EventClass.EVTCLASS_INFO), 16) OR 16#27)

    • <category>Events</category>

    • <description>Event is sent to handle own download/online-change service tags</description>

    • <param name=”pEventParam” type=”IN”>EVTPARAM_CmpAppOEMService</param>

EVT_CommCycle

DWORD

(SHL(UINT_TO_DWORD(EventClass.EVTCLASS_INFO), 16) OR 16#2A)

    • <category>Events</category>

    • <description>Event is fired at every communication cycle (idle loop). This can be used in IEC-for background jobs.</description>

    • <param name=”pEventParam” type=”IN”>EVTPARAM_CmpAppCommCycle</param>

EVT_StateChanged

DWORD

(SHL(UINT_TO_DWORD(EventClass.EVTCLASS_INFO), 16) OR 16#2B)

    • <category>Events</category>

    • <description>Event is fired, if the application state changed.</description>

    • <param name=”pEventParam” type=”IN”>EVTPARAM_CmpAppStateChanged</param>

EVT_RetainBackupState

DWORD

(SHL(UINT_TO_DWORD(EventClass.EVTCLASS_INFO), 16) OR 16#2F)

    • <category>Events</category>

    • <description>Event is sent when backup or restore of retains is served</description>

    • <param name=”pEventParam” type=”IN”>EVTPARAM_CmpAppRetainBackupState</param>

EVT_ResetAllApplications_Prepare

DWORD

(SHL(UINT_TO_DWORD(EventClass.EVTCLASS_INFO), 16) OR 16#30)

    • <category>Events</category>

    • <description>Event is sent when AppResetAllApplications is called</description>

    • <param name=”pEventParam” type=”IN”>EVTPARAM_CmpAppResetAllApplications</param>

EVT_ResetAllApplications_Done

DWORD

(SHL(UINT_TO_DWORD(EventClass.EVTCLASS_INFO), 16) OR 16#31)

    • <category>Events</category>

    • <description>Event is sent when AppResetAllApplications is finished</description>

    • <param name=”pEventParam” type=”IN”>EVTPARAM_CmpAppResetAllApplications</param>