AlarmFilterClose

This function removes the named filter from memory.

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

Syntax

INT AlarmFilterClose(STRING FilterName)

FilterName

Name of Filter

Return Value

0 (zero) if successful, otherwise an error code is returned.

Example

// This example shows how to open and close the named filter "Myfilter"
// nothing of interest is done with the filter in this example.
INT nOpenModeOld = 0;
INT nOpenModeNew = 1;
INT nOpenModeAny = 2;
INT nCloseModeManual = 0;
INT nCloseModePageChanged = 1;
INT nError;
nError = AlarmFilterOpen("MyFilter", nOpenModeNew, nCloseModeManual);
IF nError = 0 THEN
   nError = AlarmFilterClose("MyFilter");
END

Related Functions

AlarmFilterOpen

See Also

Alarm Filter Functions

Published June 2018