guiSysMenuEnable (Function)

This function enables or disables the system menu.

This function is the same as displaySysMenuEnable.

This works similarly to logging in using a password, enabled with guiSysMenuSetPassword.

The system menu can be used to show the status for the device, including network status and RCH status.

On the NX-400, the system menu can also be used to change some settings including calibration of the touch screen and setting the state of the virtual jumpers.

On the NX-400, guiWaitEvent can be used to detect when the menu is enabled:

- If the system menu is enabled, the login succeeded event is sent.

- When logging out, either by clicking "Log out" in the system menu, or when logging out due to the timeout, the logged out event is sent.

On the NX-400, the enabled menu can be access by pressing on the clock shown in the top right corner of the display.

On the LX4, the menu will be shown on the display immediately and can be navigated using the arrow keys and the OK and ESC keys.

When the menu is disabled or exited on the LX4, it will close the menu and switch back to the normal contents of the display.

Input:

enable : BOOL

If true, the system menu is enabled. If false, the system menu is disabled.

timeout: INT (-1..900) default -1

Number of seconds without activity before logging out automatically. 0 disables the timeout, -1 leaves it at its current value.

Returns: INT

Declaration:

FUNCTION guiSysMenuEnable : INT;
VAR_INPUT
  enable    : BOOL;
  timeout   : INT := -1;
END_VAR;

Example:

INCLUDE rtcu.inc
 
PROGRAM test;
 
BEGIN
  ...
  // Enable system menu with 20 second timeout.
  rc := guiSysMenuEnable(enable := TRUE, timeout := 20);
  ...
END;
END_PROGRAM;