Skip to main content

Get a Config Value from the UI (xui.get)

Declaration​

value = xui.get(domain, key)

Parameters​

  • domain
    String. The defaults domain identifier used by the config UI.
  • key
    String. The control's key identifier in the config UI.

Returns​

  • value
    Any. Different control types return different value types. Returns nil if the value does not exist.

Description​

This function does not validate value types. If you need to ensure the retrieved value matches the control's expected type, call xui.setup first to validate/correct and then read.
See the config UI standard: XUI

Examples​

xui.setup('interface.xui')
local enabled = xui.get('com.yourcompany.A-Script-Bundle', 'enabled')