AlarmSumSplit

Cicode Programming Reference > Cicode Function Categories > Alarm Functions Introduction > AlarmSumSplit

AlarmSumSplit

Duplicates the alarm summary entry identified by Index. You can use this function to add another comment to an alarm summary entry.

When the Alarm Server is not in the calling process, this function will become blocking and cannot be called from a foreground task. In this case, the return value will be undefined and a Cicode hardware alarm will be raised.

To duplicate an alarm summary entry on a Control Client, use the AlarmSplit() function - the entry at the cursor position is duplicated.

Syntax

AlarmSumSplit(Index [, ClusterName] )

Index:

The alarm summary index (returned from the AlarmSumFirst(), AlarmSumNext(), AlarmSumLast(), AlarmSumPrev(), AlarmSumAppend(), or AlarmSumFind() function).

ClusterName:

Specifies the name of the cluster in which the Alarm Server resides. This is optional if you have one cluster or are resolving the alarm server via the current cluster context. The argument is enclosed in quotation marks "".

Return Value

The Index of the new entry, or -1 on error.

Related Functions

AlarmSumGet, AlarmSumFirst, AlarmSumNext, AlarmSumLast, AlarmSumPrev, AlarmSumFind, AlarmSplit

Example

/* This function finds the first alarm summary entry that matches 
the specified tag, splits that entry and then adds the specified 
comment to the new entry. */

FUNCTION

AlarmSplitAdd(STRING Tag, STRING Comment)

	INT Index;

	STRING Name;

	Index=AlarmSumFirst();

	WHILE Index<>-1 DO

		Name=AlarmSumGet(Index,"Tag");

		IF Name=sTag THEN

			AlarmSumSplit(Index);

			Index=AlarmSumFirst();

			AlarmSumSet(Index,"Comment",Comment);

			Index=-1;

		ELSE

			Index=AlarmSumNext(Index);

		END

	END

END