SetUserPref

Introduced

1.0

Description

Sets a user preference and returns the previous setting. Some of these user preference settings correspond to the available settings in the User Preference dialog box, and some correspond to preferences that can be set from the Main Control Panel. For a list of possible settings, see UserPreference.

Note: The "AutoInspectEnabled" (siAutoInspect) preference cannot be changed permanently through scripting. For more information, see Property Editor Automatic Inspection.

Scripting Syntax

SetUserPref( Target, Value )

Parameters

Parameter

Type

Description

Target

UserPreference

User preference to set.

Value

Variant

New value for user preference. These values vary depending on what you specify for the UserPreference parameter.

See UserPreference for lists of possible value types available for each UserPreference setting.

Return Value

Returns previous value (last value before update) as a Variant.

See Also

GetUserPref

Preferences.SetPreferenceValue

Examples

• See SetUserPref.1.pys

• See SetUserPref.2.vbs

• See SetUserPref.3.js



Autodesk Softimage 2011