AlarmFilterEditClose | Alarm Filter Functions

Cicode Programming Reference > Cicode Function Categories > Alarm Filter Functions > AlarmFilterEditClose

AlarmFilterEditClose

The AlmFilterEditClose function removes the session from the memory. The filter is not reset and is valid until a new filter is created and applied.

Syntax

INT AlarmFilterEditClose(INT hSession)

Session

Session handle for the historical list previously returned by the function AlarmFilterEditOpen().

Return Value

0 (zero) if the alarm filter session exists, otherwise an error code is returned.

Example

iHndl = AlarmFilterEditOpen(iAN);
iRet = AlarmFilterEditSet(iHndl,"Tag=Dig*;Category=1;Area=1;");
iRet = AlarmFilterEditAppend(iHndl, "Priority<20");
sRet = AlarmFilterEditFirst(iHndl);	// Tag=Dig*;
sRet = AlarmFilterEditNext(iHndl);	// Category=1;
sRet = AlarmFilterEditLast(iHndl);	// Priority<20;
sRet = AlarmFilterEditPrev(iHndl);	// Area=1;
iRet = AlarmFilterEditClose(iHndl);

Related Functions

AlarmFilterEditOpen