AlarmFilterEditOpen
- Last UpdatedJul 18, 2023
- 1 minute read
The AlmFilterEditOpen function creates a session for the historical list (or lists) associated with the provided animation number (AN) or FilterName or all alarm lists displayed on the page via (-1) option. This session is initialised with the current filter applied on the lists.
It returns a session handle which will be used as parameter in all other functions to reference the session or -1 if the parameter is not a valid animation number or if this animation number is not linked to an historical list.
This function is a blocking function. It blocks the calling Cicode task until the operation is complete.
Syntax
INT AlarmFilterEditOpen(STRING FilterName or INT AN or INT -1 [, INT AutoCloseMode])
FilterName
Name of Filter
AN
Animation Number, for example 21 or 11
-1
Change the display parameters of all alarm lists displayed on the page
AutoCloseMode
Values for AutoCloseMode are bit flags.
The values for the bits are:
• 0 bit - Will not automatically close filter. Use AlarmFilterEditClose.
• 1 bit - When set, the named filter will be closed when the page is changed or otherwise closed.
Note: All other modes are reserved.
Return Value
Returns a session handle to the filter browse session. Returns -1 when an error is detected.
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);