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.