AlarmFilterEditCommit

The AlarmFilterEditCommit function takes a session handle as parameter. It validate the filter created in this session and, if valid, applies this filter to the list associated with the session.

This function is a blocking function. It blocks the calling Cicode task until the operation is complete.

Syntax

INT AlarmFilterEditCommit(INT hSession)

hSession:

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

// This example requires that the edit session hEdit exists.
INT nError;
nError = AlarmFilterEditSet(hEdit,"tag=Dig*;Category=1;");
nError = AlarmFilterEditCommit(hEdit);

Related Functions

AlarmFilterEditSet, AlarmFilterEditAppend

See Also

Alarm Filter Functions