GM.getValue

From GreaseSpot Wiki
Revision as of 21:58, 3 February 2010 by Arantius (talk | contribs) (Text replace - "{{Samp |1=<pre style="border: none; margin: inherit;">" to "<pre class='sample'>")
Jump to navigationJump to search


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+
Parameters
Properties
name
default
  • 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. If default is omitted JavaScript undefined is returned.
Note: Using this property does not call GM_setValue and is by design.


Examples

GM_log(GM_getValue("foo"));

}}

See Also

Notes