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

Alarm Filter Functions

The following Cicode functions relate to alarm filters.

AlarmFilterClose

Removes the session from memory.

AlarmFilterEditAppend

Appends the provided expression to the current filter session content without any validation.

AlarmFilterEditAppendEquipment Appends the provided expression that includes equipment names or category to the current filter session content without any validation.

AlarmFilterEditClose

Removes the session from the memory.

AlarmFilterEditCommit

Validates the filter built in this session and, if valid, applies the filter to the list associated with the session.

AlarmFilterEditFirst

Retrieves the first part of the filter.

AlarmFilterEditLast

Retrieves the last part of the filter.

AlarmFilterEditNext

Retrieves the next part of the filter.

AlarmFilterEditOpen

Creates a session for the historical list associated with the provided animation number (aN) or FilterName.

AlarmFilterEditPrev

Retrieves the previous part of the filter.

AlarmFilterEditSet

It replaces the current filter session content by the provided expression without any validation.

AlarmFilterForm

Available when using the Legacy Filter Form. Use to display an alarm form to specify filter criteria for an alarm list or a named filter.

AlarmFilterOpen

Creates a new named filter.

AlarmGetFilterName

Retrieves the name of the filter for the AN.

AlarmResetQuery

Use when using the AlarmFilterForm(). Clears the filter of the specified filter source.

LibAlarmFilterForm

Displays a generic alarm filter popup for specifying filter criteria for either an alarm list or named filter. Only available if 'Lib_controls' project is included in main project.

Note: If a requested filter is too complex (for example, it contains too many conditions or too many nested brackets), the filter is cleared (no filter is used). The hardware alarm "Too many alarms in filters" is generated on the client components, and a tracelog error message is logged.

See Also

Published June 2018