GM.getValue: Difference between revisions
From GreaseSpot Wiki
Jump to navigationJump to search
m →Description: Formatting symmetry. |
m →Examples: marking core sample code vs other sample code. |
||
| Line 50: | Line 50: | ||
== Examples == | == Examples == | ||
{{Core samp |1=<pre style="border: none; margin: inherit;"> | |||
alert(GM_getValue("foo")); | alert(GM_getValue("foo")); | ||
</pre> | </pre>}} | ||
[[#top|top]] | [[#top|top]] | ||
Revision as of 04:30, 7 May 2009
 Greasemonkey Manual |
| Using Greasemonkey |
|---|
| Installing Scripts |
| Monkey Menu |
| Getting Help |
| User Script Authoring |
| Editing |
| Environment |
| API |
Description
This API method retrieves a value that was set with GM_setValue. If nothing was set and a default value is passed, it returns that default. Failing that, it returns undefined.
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.scriptvals.namespace/name.foo".
Syntax
GM_getValue( name, default )
- Value: Function
- Returns: String, Integer, Boolean, undefined and 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;
- Note: Using this property does not call GM_setValue and is by design.
