GetAlarm

Returns an interface pointer to an existing instance.

Syntax

virtual HRESULT TCOMAPI GetAlarm (GUID eventClass, UDINT eventId, ITcSourceInfo ipSourceInfo, ITcAlarm pipAlarm)

Parameter

Name

Type

Description

eventClass

REFERENCE TO GUID

Reference to the GUID of the event class.

eventId

REFERENCE TO UDINT

Reference to the ID of the event.

ipSourceInfo

ITcSourceInfo

Pointer to the ITcSourceInfo interface.

pipAlarm

ITcAlarm

Pointer to an ITcAlarm pointer.

GetAlarm 1: Return value

Type

Description

HRESULT

Returns ADS_E_NOTFOUND if no instance was found.

Returns S_OK if everything was successful, otherwise an HRESULT as the error code.