preference::get_user_pref (public)

 preference::get_user_pref -preference_type preference_type \
    -package_id package_id -user_id user_id

Defined in packages/user-preferences/tcl/preference-procs.tcl

Get a user, package, or default preference. The preference can be obtained at four different levels:

package_id	user_id	Returns
package_id	user_id	User preference for package_id (set with set_user_pref)
null	user_id	User preference for all packages (set with set_user_pref)
package_id	null	Package default (set with set_package_default)
null	null	System default (set with preference::type::new)

Note: null == empty string (""), ...

Switches:

-preference_type (required)

A short string that identifies the preference. This corresponds to the short_name parameter passed to preference::type::new.

-package_id (required)

This can be the real package id, or an empty string.

-user_id (required)

This can be the real user id, or an empty string.

See Also:

• preference::type::new
• preference::set_package_default
• preference::set_user_pref

Testcases:

No testcase defined.