IAlarmHandler2.GetActiveAlarms (METH)ΒΆ

METHOD GetActiveAlarms : UDINT

Returns the alarms, that are currently active, according to given filter criteria of the IAlarmManagerClient instance. The return value indicates, whether the processing was successful or not: * ERR_OK: Output parameters of method are valid, client was found * ERR_NO_OBJECT: Client was not found, has been not yet added to the vector * ERR_NOTINITIALIZED: No client has been registered at the alarm manager

InOut:

Scope

Name

Type

Comment

Return

GetActiveAlarms

UDINT

Input

itfAlarmManagerClient

IAlarmManagerClient

The IAlarmManagerClient instance

Output

parritfActiveAlarms

POINTER TO ARRAY [0..0] OF IAlarm

Points to an array of IAlarm instances, that are the alarms, that fit the filter criteria and that are currently active.

iCountActiveAlarms

INT

The effective size of the array above