GM.getValue: Difference between revisions
From GreaseSpot Wiki
Jump to navigationJump to search
mNo edit summary |
m (→Syntax: Monkey colored tables) |
||
| Line 18: | Line 18: | ||
:Compatibility: [[Version_history#0.3_beta|Greasemonkey 0.3b+]] | :Compatibility: [[Version_history#0.3_beta|Greasemonkey 0.3b+]] | ||
:{| | :{| cellpadding="5" style="border-style:solid; background:#FFFFE0;" | ||
|+ Parameters | |+ Parameters | ||
!|'''Properties''' | !style="background:#CC9900;"|'''Properties''' | ||
|- | |- | ||
| <code>[[#name |name]]</code> | | <code><span style="background:#FFFFE0;">[[#name |name]]</span></code> | ||
|- | |- | ||
|<code>[[#default |default]]</code> | |<code><span style="background:#FFFFE0;">[[#default |default]]</span></code> | ||
|} | |} | ||
:* All properties are optional except [[#name|name]]. | :* All properties are optional except [[#name|name]]. | ||
Revision as of 22:26, 11 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 )
- Value: Function
- 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"));
See Also
Notes
[1] The null value should be undefined in prefmanager.js
