ClearAlarms

Method for clearing active alarms. Returns S_OK if successful.

Syntax

METHOD ClearAlarms     : HRESULT
VAR_INPUT
    nTimeStamp         : ULINT := 0; 
    bResetConfirmation : BOOL := FALSE; 
    ipFilter           : I_TcEventFilter; 
END_VAR

Inputs

Name	Type	Description
nTimeStamp	ULINT	Set to 0 to obtain the current time automatically. Initial: 0
bResetConfirmation	BOOL	If TRUE and the confirmation status is WaitForConfirmation, the confirmation status is set to Reset. Otherwise, the confirmation status is not changed. Initial: FALSE
ipFilter	I_TcEventFilter	Specify which alarms are to be cleared, otherwise all triggered alarms are cleared.

Return value

Name	Type	Description
ClearAlarms	HRESULT	Returns S_OK if the method call was successful, otherwise an HRESULT as the error code.