Displays a form for specifying filtering criteria for either an alarm list or a named filter. This function uses the AlarmFilterEdit family of Cicode functions to set the filter.
Note: If the user passes in the Animation number of an alarm list as its FitlerSrc argument, the filter set by this function will override the filter set by function AlarmSetInfo() as both functions modify the internal filter associated with the alarm list.
Syntax
INT AlarmFilterForm(INT nIndex, INT nMode = 0, INT nDebug = 0, STRING nFilterSrc = "-1")
Index
Mode
Debug
For debugging filter values; 1 will write filter parameters to file - filter.txt in the [run] folder
FilterSrc
The source where the filter will be applied to. It can either be the Animation Number (AN) of an alarm list or the name of a filter created via the AlarmFilterOpen() Cicode function. If it is not specified, it is defaulted to -1 which refers to all alarm lists on the current page.
Return Value
1 if filter has been applied, 0 if filter has been cleared, or -1 if no change is made.
Related Functions
AlarmResetQuery, AlarmFilterOpen
See Also
Alarm Filter Help available when using the Legacy Alarm Filter Form at Runtime
Published June 2018