GetHeader

ITcEventC

This method returns the event Header that includes most of the event parameter in one bunch.

HRESULT GetHeader([out]TcEventHeader* pHead);

Parameters

pHead

[in] Pointer to an object of the type TcEventHeader. The object represents the alarm configuration.

 

Return Values

S_OK

Function was successfully called

E_POINTER

pVal was no valid pointer.

Visual Basic sample code

' get the one and only event logger
Dim evtLogger As TCEVENTLOGGERLib.TcEventLog
Set evtLogger = New TCEVENTLOGGERLib.TcEventLog

' get the most recent active event
Dim evt As ITcEventC
Set evt = evtLogger.GetLastEvent

' get the event header
Dim head As TcEventHeader
Call evt.GetHeader(head)