Cicode Programming Reference > Cicode Function Categories > Alarm Functions > AlarmDspClusterRemove

AlarmDspClusterRemove

Removes a cluster from a client's alarms list. Alarms for the specified cluster will be removed from the alarms list at the AN number.

If the cluster to be removed is the last cluster, the call will be unsuccessful.

Syntax

AlarmDspClusterRemove(nAN, sClusterName)

nAN:

The AN used in the original AlarmDsp() call.

sClusterName:

The name of the cluster to remove from this alarm list. The argument is enclosed in quotation marks ("").

Return Value

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

Related Functions

AlarmDspClusterAdd, AlarmDSPClusterInUse, AlarmDsp

See Also

Published June 2018