AlarmFilterEditHasField

The AlarmFilterEditHasField function checks whether an alarm field name or any field in a set of field names is used in the filter specified in an alarm filter edit session.

Syntax

INT AlarmFilterEditHasField(INT hSession, STRING sFieldName)

Session:

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

sFieldName

The alarm field name or names separated by comma (no space) to be checked if it is used in filter criteria.

Return Value

1 (TRUE) if the filter criteria is valid and alarm field name is used, otherwise 0 (FALSE) is returned.

Example

iHndl = AlarmFilterEditOpen(iAN);

iRet = AlarmFilterEditSet(iHndl, "Tag=Dig*;Category=1;Area=1");

iRet = AlarmFilterEditHasField(iHndl, "Tag"); // 1 as Tag field is used

iRet = AlarmFilterEditHasField(iHndl, "Desc"); // 0 as Desc field is not used

iRet = AlarmFilterEditSet(iHndl, "NewCar=Fantastic;");

iRet = AlarmFilterEditHasField(iHndl, "NewCar"); // 0 as filter criteria is invalid

Related Functions

AlarmFilterEditSet

See Also

Alarm Filter Functions