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

AlarmGetOrderbyKey

Retrieves the list of key(s) that are used to determine the order of the alarm list. These keys can be set by the AlarmSetInfo() function.

Syntax

AlarmGetOrderbyKey(AN)

AN:

The AN where the alarm list (with the required information) is displayed.

Return Value

Order-by key (as a string).

Example

page = AlarmGetOrderbyKey(21);
! returns the order-by key string of the alarm list at AN '21'.

See Also

Alarm Functions