User Guide

274 Chapter 14: Document
dreamweaver.getPreferenceInt()
Availability
Dreamweaver MX.
Description
Lets you retrieve an integer preference setting for an extension.
Arguments
section, key, default_value
• The section argument is a string that specifies the preferences section that contains the entry.
• The key argument is a string that specifies the entry of the value to retrieve.
• The default_value argument is the default value that Dreamweaver returns if it cannot find
the entry. This value must be an unsigned integer in the range 0 through 65,535 or a signed
integer in the range -32,768 through 32,767.
Returns
Integer value of the specified entry in the specified section or the default value if the function does
not find the entry. Returns 0 if the value of the specified entry is not an integer.
Example
The following example returns the integer value of the Snap Distance setting in the My Extension
section of Preferences. If there is no MyExtension section or no Snap Distance entry, the function
returns the specified default value of 0.
var snapDist; //default value if entry not found
snapDist = dreamweaver.getPreferenceInt("My Extension", "Snap Distance", 0);
dreamweaver.getPreferenceString()
Availability
Dreamweaver MX.
Description
Lets you retrieve a string preference setting that you stored for an extension.
Arguments
section, key, default_value
• The section argument is a string that specifies the preferences section that contains the entry.
• The key argument is a string that specifies the value to retrieve.
• The default_value argument is the default string value that Dreamweaver returns if it cannot
find the entry.
Returns
The requested preference string, or if the string cannot be found, the default value.
000_DW_API_Print.book Page 274 Wednesday, August 20, 2003 9:14 AM