Navigation

Operators and Keywords

Function List:

C++ API

: val = getpref ("group", "pref")
: val = getpref ("group", "pref", default)
: {val1, val2, …} = getpref ("group", {"pref1", "pref2", …})
: prefstruct = getpref ("group")
: prefstruct = getpref ()

Return the preference value corresponding to the named preference pref in the preference group group.

The named preference group must be a string.

If pref does not exist in group and default is specified, create the preference with value default and return default.

The preference pref may be a string or cell array of strings. If it is a cell array of strings then a cell array of preferences is returned.

The corresponding default value default may be any Octave value, .e.g., double, struct, cell array, object, etc. Or, if pref is a cell array of strings then default must be a cell array of values with the same size as pref.

If neither pref nor default are specified, return a structure of preferences for the preference group group.

If no arguments are specified, return a structure containing all groups of preferences and their values.

See also: addpref, setpref, ispref, rmpref.

Package: octave