Package: gio

Function gio:settings-enum

Lambda List

gio:settings-enum (settings key)

Syntax

(g:settings-enum settings) => value
(setf (g:settings-enum settings) value)

Arguments

settings -- a g:settings object
key -- a string for the key to get the value for
value -- an integer for the value

Details

Gets or sets the value that is stored in settings for key and converts it to the enum value that it represents. In order to use this function the type of the value must be a string and it must be marked in the schema file as an enumerated type.

It is a programmer error to give a key that is not contained in the schema for settings or is not marked as an enumerated type.

If the value stored in the configuration database is not a valid value for the enumerated type then this function will return the default value.

 

See also

#2026-03-24