Difference between revisions of "GM.setValue"

From GreaseSpot Wiki
Jump to navigationJump to search
(simplify)
Line 14: Line 14:
== Syntax ==
== Syntax ==


'''GM_setValue(''' ''name'', ''value'' ''')'''
{{Function|GM_setValue|name, value}}


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


:{| cellpadding="5" style="border-style:solid; background:#FFFFE0;"
== Arguments ==
|+ Parameters
!style="background:#CC9900;"|'''Properties'''
|-
| <code><span style="background:#FFFFE0;">[[#name |name]]</span></code>
|-
|<code><span style="background:#FFFFE0;">[[#value |value]]</span></code>
|}
:* All properties are optional except [[#name|name]] and [[#value|value]].


=== Properties ===
; <code>name</code>
----
: <code>String</code> The unique (within this script) name for this value.  Should be restricted to valid Javascript identifier characters.
==== <code>name</code> ====
; <code>value</code>
:Value: String
: <code>String</code>, <code>Integer</code> or <code>Boolean</code> Any valid value of these types.  Any other type may cause undefined behavior, including crashes.
:Usage: <code>'''name''' = "PropertyName";</code>


:* Property name to retrieve or create.
== Returns ==
 
 
==== <code>value</code> ====
:Value: String, Integer or Boolean
:Usage: <code>'''value''' = 5;</code>


<code>undefined</code>


== Examples ==


== Examples ==
<pre class='sample'>
<pre class='sample'>
GM_setValue("foo", "bar");
GM_setValue("foo", "bar");
Line 51: Line 36:


== See Also ==
== See Also ==
* [[GM_getValue]]
* [[GM_getValue]]
* [[GM_deleteValue]]
* [[GM_deleteValue]]
* [[GM_listValues]]
* [[GM_listValues]]
* [[:Category:Coding Tips:Persistence]]


== Notes ==
== Notes ==
<sup>[[GM_setValue#top|[1]]]</sup> 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.


[[Category:API_Reference|S]]
[[Category:API_Reference|S]]

Revision as of 16:15, 8 February 2010


Description

This method allows user script authors to persist simple values.

Strings, booleans, and integers are currently the only allowed data types. Values are saved in the Firefox preferences back end and can be manually inspected or changed by typing about:config in the address bar and searching for the preference name "greasemonkey.scriptvals.namespace/name.value_name". (For appropriate values of namespace, name and value_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]

Syntax

function GM_setValue( name, value )

Compatibility: Greasemonkey 0.3b+

Arguments

name
String The unique (within this script) name for this value. Should be restricted to valid Javascript identifier characters.
value
String, Integer or Boolean Any valid value of these types. Any other type may cause undefined behavior, including crashes.

Returns

undefined

Examples

GM_setValue("foo", "bar");

See Also

Notes

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