PageAlarm
- Last UpdatedJul 18, 2023
- 1 minute read
Displays a category of active alarms on the alarm page.
To use this function, you need to have a page in your project that was created using the Alarm template. By default, the name of the page is expected to be "Alarm". However, you can use an alarm page with a different name by adjusting the setting for the INI parameter [Page]AlarmPage.
Note:
• The operation of this function has changed. In Version 2.xx this function displayed
the built-in alarm page from the Include project.
• This function is not supported in the server process in a multiprocessor environment.
Calling this function from the server process results in a hardware alarm being raised.
Syntax
PageAlarm( [Category] )
Category:
The alarm category to display. Set to 0 (the default) to display all alarm categories.
Return Value
0 (zero) if successful, otherwise an error is returned.
Related Functions
Example
System Keyboard
|
Key Sequence |
AlarmPage |
|
Command |
PageAlarm(0) |
|
Comment |
Display active alarms on the alarm page |
System Keyboard
|
Key Sequence |
Alarm ### Enter |
|
Command |
PageAlarm(Arg1) |
|
Comment |
Display a specified category of active alarms on the alarm page |