TabAlarm_GetAn

Using the Tab Style Page Templates > Tab Style Template Reference > Tab Style Template Functions > TabAlarm_GetAn

TabAlarm_GetAn

Gets the Animation Number (AN) of the alarm list on the provided alarm templates. The returned AN can be passed to the alarm family of Cicode functions such as AlarmSetInfo(), AlarmGetInfo() etc. to further manipulate the alarm list.

Note: The alarm list displayed by the alarm templates is instantiated using the new noDraw mode. This helps eliminate the need to have consecutive ANs for each row of the alarm records displayed on screen. Therefore, this alarm list is not compatible with any alarm Cicode functions that operates on current cursor position, such as mode 0 of AlarmGetInfo(), AlarmSetInfo(), etc.

Syntax

TabAlarm_GetAn(iListID)

iListID

The list number of the alarm list used by the alarm templates:

0 - last alarm list (at alarm banner)
1 - main alarm list (only exist on alarm templates)

Return Value

The AN of the alarm list, otherwise -1 is returned.

Related Functions

Alarm Functions