GM.getValue: Difference between revisions

From GreaseSpot Wiki
Jump to navigationJump to search
m (→‎Examples: marking core sample code vs other sample code.)
m (→‎Examples: Moving output to error console instead of alert()... could be huge depending on app)
Line 51: Line 51:
== Examples ==
== Examples ==
{{Core samp |1=<pre style="border: none; margin: inherit;">
{{Core samp |1=<pre style="border: none; margin: inherit;">
alert(GM_getValue("foo"));
GM_log(GM_getValue("foo"));
</pre>}}
</pre>}}



Revision as of 05:33, 7 May 2009

Template:Underscore


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".

Examples | See Also | Notes

Syntax

GM_getValue( name, default )

Value: Function
Returns: String, Integer, Boolean, undefined and null[1]
Compatibility: Greasemonkey 0.3b+
Parameters
Properties
name
default
  • All properties are optional except name.

top

Properties


name

Value: String
Usage: name = "PropertyName";
  • Property name to retrieve.

top | back

default

Value: String, Integer or Boolean
Usage: default = 5;
  • If name is not found, then use this property to return a default value. If default is omitted JavaScript undefined is returned.
Note: Using this property does not call GM_setValue and is by design.

top | back

Examples

Template:Core samp

top

See Also

top

Notes

top