GM.getValue: Difference between revisions
From GreaseSpot Wiki
Jump to navigationJump to search
m →Syntax |
mNo edit summary |
||
| Line 32: | Line 32: | ||
==== <code>name</code> ==== | ==== <code>name</code> ==== | ||
:Value: String | :Value: String | ||
:Usage: <code>name = "PropertyName";</code> | :Usage: <code>'''name''' = "PropertyName";</code> | ||
:* Property name to retrieve. | :* Property name to retrieve. | ||
| Line 40: | Line 40: | ||
==== <code>default</code> ==== | ==== <code>default</code> ==== | ||
:Value: String, Integer or Boolean | :Value: String, Integer or Boolean | ||
:Usage: <code>default = 5;</code> | :Usage: <code>'''default''' = 5;</code> | ||
:* If [[GM_getValue#name|name]] is not found, then use this property to return a default value. | :* If [[GM_getValue#name|name]] is not found, then use this property to return a default value. | ||
Revision as of 02:49, 7 December 2007
Description
This API method retrieves a value that is set with GM_setValue.
Values are saved in the Firefox preferences back end and can be manually changed by typing about:config in the address bar and searching for the preference name "greasemonkey.scriptval.script-namespace/script-name".
Syntax
GM_getValue( name, default )
- Returns: String, Integer, Boolean or null[1]
- Compatibility: Greasemonkey 0.3b+
- All properties are optional except name.
Properties
name
- Value: String
- Usage:
name = "PropertyName";
- Property name to retrieve.
default
- Value: String, Integer or Boolean
- Usage:
default = 5;
- If name is not found, then use this property to return a default value.
- Note: Using this property does not call GM_setValue and is by design.
Examples
alert(GM_getValue("foo"));
Notes
[1] This value should be undefined in prefmanager.js
