IACAlarmExtender3.GetActiveAlarmsOfModule (METH) ¶ METHOD GetActiveAlarmsOfModule : BOOL This method gets all currently active alarms that belong to the module instance defined by itfModule . Note For using this method one must activate the option to sort alarms per module in the options of the Alarm-Generator. InOut: Scope Name Type Comment Return GetActiveAlarmsOfModule BOOL The return value indicates if it was possible to get all active alarms that belong to itfModule . The return value does also take into account if the size of the array pointed to pActiveAlarms was adequate. Input itfModule AC.IModule The module the active alarms shall be searched. pActiveAlarms POINTER TO AlarmManager.IAlarm Pointer to an array of AlarmManager.IAlarm . Here the found alarms are stored. uiSizeOfActiveAlarms UINT The size of the array pActiveAlarms is pointing to. Output uiNumFoundAlarms UINT The number of found alarms.

IACAlarmExtender3.InitSortedModuleAlarms (METH) ¶ METHOD InitSortedModuleAlarms : BOOL This function is called by Init-code generated by ApplicationComposer. InOut: Scope Name Type Return InitSortedModuleAlarms BOOL Input pModuleAlarmInfos POINTER TO ModuleAlarmInfo uiModuleAlarmInfos UINT

ModuleAlarmInfo (STRUCT) ¶ TYPE ModuleAlarmInfo : STRUCT InOut: Name Type inst AC.IModule pAlarms POINTER TO AlarmInfo uiNumAlarms UINT

ModuleCall (STRUCT) ¶ TYPE ModuleCall : STRUCT A structure internally used by the alarm generator to generate the module calls after an alarm was issued. InOut: Name Type Comment inst AC.IModule The module instance defining a module call calltype UINT The module call type defined by the module instance

ModuleEvent (STRUCT) ¶ TYPE ModuleEvent : STRUCT InOut: Name Type Comment inst AC.IModule uliEventID ULINT built by the hashcode from Target of SetAlarm section alarmGroupID AlarmManager.ALARMGROUP_ID alarmID AlarmManager.ALARM_ID

Functions ¶ Helper function to handle module calls. RaiseModuleEvent (Function) ReplaceAlarmPlaceholderString (Function)

RaiseModuleEvent (FUN) ¶ FUNCTION RaiseModuleEvent : BOOL This function raises an event that has been configured as Event-Alarm of an Module-Instance InOut: Scope Name Type Comment Return RaiseModuleEvent BOOL Input itfAlarmHandler AlarmManager.IAlarmHandler The alarm handler that shall raise an alarm. If this parameter is 0 g_AlarmHandler from AlarmManager library is used inst AC.IModule The module instance that defines the Event-Alarm pEventID POINTER TO STRING The Target of the Event-Alarm in the module description

ReplaceAlarmPlaceholderString (FUN) ¶ FUNCTION ReplaceAlarmPlaceholderString : STRING This function can be used to replace placeholders in a message (i.e. latch variables as “LATCHVAR1” or “LATCHVAR2”) by some strings. This function can be used to get the resulting alarm message for display when getting a module call after an alarm was issued. InOut: Scope Name Type Comment Return ReplaceAlarmPlaceholderString STRING The replaced string. Input strMessage STRING Message which has a placeholder to be replaced strPlaceholder STRING The placeholder strReplacement STRING The string the placeholder shall be replaced with

GlobalTextList (Text List) ¶ ID Default en de 1 ACK all visible ACK all visible Alle sichtbaren Alarme bestätigen 0 ACK selected ACK selected Selektierte Alarme bestätigen 3 Freeze Scrl Pos Freeze Scrl Pos Scrl Position einfrieren 2 History History Historie

ModuleInterface ¶ Interfaces used by the alarm generator in order to define and get module calls. IModuleAlarming (Interface) ConsumeModuleAlarm (Method)