beautypg.com

Alarmnotifierclear, Alarmnotifierclear -29, 6 alarmnotifierclear – Echelon i.LON 100 e2 Internet Server User Manual

Page 135

background image

i.

LON 100 Internet Server Programmer’s Reference

8-29

8.2.1.6 AlarmNotifierClear

Use the AlarmNotifierClear function to clear a group of log entries from an Alarm Notifier
log file. This function only deletes the log entries. You can delete the Alarm Notifier itself

with the AlarmNotifierDelete function.
You can specify which alarm entries are to be cleared out by filling the properties described
in Table 42 into the parameter you supply to the function. If you do not fill in these

properties, the entire alarm log will be cleared.

Table 42 AlarmNotifierClear Input Properties

Parameter Description

The index number of the Alarm Notifier to be affected.

The name of the data point whose log entries are to be deleted. If no
data point name is specified, log entries for all data points will be

deleted.

Use this field to specify the maximum number of log entries the function

will delete. If you do not fill in this property, all log entries for the

applicable data point (or data points) will be cleared.


Use these fields to specify a time range for the alarm time of each log

entry to be deleted. You can specify a start and stop time, or just a stop
time.
If you specify a start and stop time and the number of log entries during
this interval exceeds the count entered, the function will clear out the

first group of log entries recorded during that interval.
If you only specify a stop time and the number of log entries before that
time exceeds the count entered, the function will clear out the first

group of log entries that recorded during that interval.
If you do not enter a start or stop time, the function will clear out all log
entries for the applicable data points, up to the maximum.
You must enter these properties as timestamps in local time, with

appended time zone indicators that denote the difference between local
time and UTC. For more information on this format, see Local Times

and Coordinated Universal Time on page 6-12.


The following call to the AlarmNotifierClear function deletes all log entries for data point
NVL_nviBgtVa from the Alarm Notifier with index number 0 that occurred between

1/31/2001 at 14:30 and 2/28/2001 at 14:30. Since the count entered is 200, it will delete the
first 200 log entries if the total log entries for the time span selected exceeds 200.