Difference between revisions of "GM.getValue"

From GreaseSpot Wiki
Jump to navigationJump to search
m (→‎Syntax: Monkey colored tables)
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 [[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.''script-namespace''/''script-name''".


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


== Syntax ==
== Syntax ==
Line 15: Line 15:


:Value: Function
:Value: Function
:Returns: String, Integer, Boolean or null<sup>[[#Notes|[1]]]</sup>
:Returns: String, Integer, Boolean or undefined
:Compatibility: [[Version_history#0.3_beta|Greasemonkey 0.3b+]]
:Compatibility: [[Version_history#0.3_beta|Greasemonkey 0.3b+]]


Line 59: Line 59:


[[#top|top]]
[[#top|top]]
== Notes ==
<sup>[[GM_getValue#Syntax|[1]]]</sup> The <code>null</code> value should be <code>undefined</code> in prefmanager.js


[[#top|top]]
[[#top|top]]
[[Category:API_Reference|G]]
[[Category:API_Reference|G]]

Revision as of 23:30, 2 January 2008

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 | See Also

Syntax

GM_getValue( name, default )

Value: Function
Returns: String, Integer, Boolean or undefined
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

See Also

top

top