GM.getValue: Difference between revisions
From GreaseSpot Wiki
Jump to navigationJump to search
No edit summary |
m Inclusive changes with discussion |
||
| Line 8: | Line 8: | ||
Values are saved in the [http://developer.mozilla.org/en/docs/Code_snippets:Preferences Firefox preferences] back end and can be manually changed by typing [[mozillazine:About:config|about:config]] in the address bar and searching for the preference name "greasemonkey.scriptval.''script-namespace''/''script-name''". | Values are saved in the [http://developer.mozilla.org/en/docs/Code_snippets:Preferences Firefox preferences] back end and can be manually changed by typing [[mozillazine:About:config|about:config]] in the address bar and searching for the preference name "greasemonkey.scriptval.''script-namespace''/''script-name''". | ||
[[#Examples|Examples]] | [[#See_Also|See Also]] | [[#Examples|Examples]] | [[#See_Also|See Also]] | [[#Notes|Notes]] | ||
== Syntax == | == Syntax == | ||
| Line 15: | Line 15: | ||
:Value: Function | :Value: Function | ||
:Returns: String, Integer, Boolean or | :Returns: String, Integer, Boolean or null<sup>[[Talk:GM_getValue|[1]]]</sup> | ||
:Compatibility: [[Version_history#0.3_beta|Greasemonkey 0.3b+]] | :Compatibility: [[Version_history#0.3_beta|Greasemonkey 0.3b+]] | ||
| Line 60: | Line 60: | ||
[[#top|top]] | [[#top|top]] | ||
== Notes == | |||
[[#top|top]] | |||
[[Category:API_Reference|G]] | [[Category:API_Reference|G]] | ||
Revision as of 21:45, 3 January 2008
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"));
