Cicode Programming Reference > Cicode Function Categories > Page Functions Introduction > PageSummary

PageSummary

Displays a category of alarm summary entries on the alarms summary page.

To use this function, you need to have a page in your project that was created using the Summary template. By default, the name of the page is expected to be "Summary". However, you can use an alarm page with a different name by adjusting the setting for the INI parameter [Page]SummaryPage.

Notes

Syntax

PageSummary(Category)

Category:

The category number for the alarms you want to summarise.

Return Value

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

Related Functions

PageAlarm

Example

System Keyboard

Key Sequence

SummaryPage

Command

PageSummary(0)

Comment

Display alarm summary entries on the alarm page

System Keyboard

Key Sequence

Summary ### Enter

Command

PageSummary(Arg1)

Comment

Display a specified category of alarm summary entries on the alarm page

See Also