GM.getValue: Difference between revisions

From GreaseSpot Wiki
Jump to navigationJump to search
m (Added Greasemonkey Manual TOC widget)
m (→‎Description: Link to metadata vals)
Line 7: Line 7:
This [[API_reference|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.
This [[API_reference|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 [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.[[Metadata_block#.40namespace|namespace]]/[[Metadata_block#.40name|name]].


[[#Examples|Examples]] | [[#See_Also|See Also]] | [[#Notes|Notes]]
[[#Examples|Examples]] | [[#See_Also|See Also]] | [[#Notes|Notes]]

Revision as of 23:11, 5 January 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.scriptval.namespace/name.

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

alert(GM_getValue("foo"));

top

See Also

top

Notes

top