GM.getValue: Difference between revisions

From GreaseSpot Wiki
Jump to navigationJump to search
Marti (talk | contribs)
m Sorry about the typos... lots to triple check
Marti (talk | contribs)
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 <code>about:config</code> 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 <code>about:config</code> in the address bar and searching for the preference name "greasemonkey.scriptval.''script-namespace''/''script-name''".


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


== Syntax ==
== Syntax ==

Revision as of 01:00, 7 December 2007

Template:Underscore


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

Examples | Notes | See Also

Syntax

GM_getValue( name, default )

Returns: String, Integer, Boolean or 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.
Note: Using this property does not call GM_setValue and is by design.

top | back

Examples

alert(GM_getValue("foo"));

top

Notes

[1] This value should be undefined in prefmanager.js

top

See Also

top