Difference between revisions of "GM.setValue"

From GreaseSpot Wiki
Jump to navigationJump to search
(→‎Notes: clean up un-terminated, probably unwanted tag)
m (Inclusive changes and discussion)
Line 9: Line 9:
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 <code>greasemonkey.scriptval.''script-namespace''/''script-name''</code>.
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 <code>greasemonkey.scriptval.''script-namespace''/''script-name''</code>.


The firefox preference store is not designed for storing large amounts of data, there are no hard limits, but very large amounts of data may cause firefox to consume more memory and/or run more slowly.<sup>[[#Notes|[1]]]</sup>
The Firefox preference store is not designed for storing large amounts of data. There are no hard limits, but very large amounts of data may cause Firefox to consume more memory and/or run more slowly.<sup>[[#Notes|[1]]]</sup>


[[#Examples|Examples]] | [[#See_Also|See Also]] | [[#Notes|Notes]]
[[#Examples|Examples]] | [[#See_Also|See Also]] | [[#Notes|Notes]]
Line 18: Line 18:


:Value: Function
:Value: Function
:Returns: Nothing
:Returns: Nothing<sup>[[Talk:GM_setValue|[2]]]</sup>
:Compatibility: [[Version_history#0.3_beta|Greasemonkey 0.3b+]]
:Compatibility: [[Version_history#0.3_beta|Greasemonkey 0.3b+]]


Line 61: Line 61:


== Notes ==
== Notes ==
Please see [http://groups.google.com/group/greasemonkey-users/t/ca5a0dfac5c5998b this mailing list thread] for details.
<sup>[[GM_setValue#top|[1]]]</sup> Please see [http://groups.google.com/group/greasemonkey-users/t/ca5a0dfac5c5998b this mailing list thread] for details.


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

Revision as of 16:52, 3 January 2008

Template:Underscore


Description

This API method allows user script authors to persist simple values locally.

Strings, booleans, and integers are currently the only allowed data types. 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.

The Firefox preference store is not designed for storing large amounts of data. There are no hard limits, but very large amounts of data may cause Firefox to consume more memory and/or run more slowly.[1]

Examples | See Also | Notes

Syntax

GM_setValue( name, value )

Value: Function
Returns: Nothing[2]
Compatibility: Greasemonkey 0.3b+
Parameters
Properties
name
value
  • All properties are optional except name and value.

top

Properties


name

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

top | back

value

Value: String, Integer or Boolean
Usage: value = 5;

top | back

Examples

GM_setValue("foo", "bar");

top

See Also

top

Notes

[1] Please see this mailing list thread for details.

top