Appearance

SET_USER_PREFERENCES ​

SET_USER_PREFERENCES changes the value of the specified user preference. This command directly accesses the database.

Syntax ​

leo-grammar
CC "Core" SET_USER_PREFERENCES preference:strValue val:strValue

#-->RESULT ecode:intValue

Parameters ​

  • preference (strValue) - a preference string that may have one of the following values "GPM_WB" - docking windows settings; "GPM_WW" - Work window settings; "DOCUMENTATION SETTINGS" - documentation settings; "REFERENCEPROFILE - Default" - Default reference settings, used by the "open model" routine, e.g. from the Explorer; "REFERENCEPROFILE - Docu" - "Docu" reference settings; "ACFILTER SETTINGS" - Settings for the "attribute and class filter"; "MESSAGING" - settings for messaging.
  • val (strValue) - contains the "preference" value; it must be valid LEO and ending with a newline character.

Returns ​

  • ecode (intValue) - Contains the error code or is 0 in case of success.

Details ​

See Also ​

GET_USER_PREFERENCES

Examples ​

Set the documentation user preferences

asc
# get the documentation user preferences
CC "Core" GET_USER_PREFERENCES preference:"DOCUMENTATION SETTINGS"
# set the preferences as read from the DB
CC "Core" SET_USER_PREFERENCES preference:"DOCUMENTATION SETTINGS" val:(val)

Versions and Changes ​

Available since ADOxx 1.3