IAlarmHandler7.GetInstanceAlarmByName (METH)ΒΆ

METHOD GetInstanceAlarmByName : IAlarm8

Provides access to alarm specific data of instantiated function blocks. If a function block is used in several alarm group templates this function can be used to obtain the correct alarm instance. Also, if several alarm templates are using the same function block, this function returns the correct alarm instance. Returns NULL if no alarm is found.

InOut:

Scope

Name

Type

Comment

Return

GetInstanceAlarmByName

IAlarm8

Input

pFBInstance

POINTER TO BYTE

Pointer to the template FB instance. Use THIS when inside the fucntion block.

uiTemplateAlarmId

ALARM_ID

Alarm ID within the related alarm group template.

stAlarmTemplateName

STRING(255)

Name of the related alarm group template of this template instance. In case of multiple alarm group template objects that use the same FB as type, specify the specific type.

Output

usiAlarmGroupID

ALARMGROUP_ID

Id of the related alarm group. Can be used to acknowledge this alarm by using methods like IAlarmHandler.AcknowlegeOneOfGroup.

uiAlarmid

ALARM_ID

Alarm ID of this alarm in the related alarm group. Can be used to acknowledge this alarm by using methods like IAlarmHandler.AcknowlegeOneOfGroup.