AlarmSplit

Splits an alarm summary entry which has no Off time. The current entry will be given an off time equal to the time when AlarmSplit() is called, and the new entry will have the same On time, with empty Off time.

If the alarm summary record has a valid Off time, the function does nothing.

You would normally call this function from a keyboard or mouse command.

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

Syntax

AlarmSplit([INT AN])

AN:

Animation Number where alarm is displayed. You can:

• Set AN to where alarm is displayed which equals to AN of alarm list + Offset into the list
• Do not specify AN or set it to 0 or negative value to use current cursor value.

Return Value

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

Related Functions

AlarmSumSplit

Example

See Also

Alarm Functions

Published June 2018