Difference between revisions of "GM.listValues"

From GreaseSpot Wiki
Jump to navigationJump to search
m (Text replace - "[[Metadata_block" to "[[Metadata Block")
(simplify)
Line 3: Line 3:
== Description ==
== Description ==


This [[API_reference|API]] method retrieves an array of preference names that start with the branch's root.
This method retrieves an array of preference names that this script has stored.
See [[GM_setValue]] for details on the storage of these values.


Values are retrieved from the [http://developer.mozilla.org/en/docs/Code_snippets:Preferences Firefox preferences] back end and can be manually viewed by typing [[mozillazine:About:config|about:config]] in the address bar and searching for the preference name "<code>greasemonkey.scriptvals.[[Metadata Block#.40namespace|namespace]]/[[Metadata Block#.40name|name]].</code>".
== Syntax ==


{{Function|GM_listValues|}}


Compatibility: [[Version_history#0.8.20090123.1|Greasemonkey 0.8.1+]]


== Syntax ==
== Arguments ==


'''GM_listValues()'''
None.


:Value: Function
== Returns ==
:Returns: String Array
:Compatibility: [[Version_history#0.8.20090123.1|Greasemonkey 0.8.1+]]


:{| cellpadding="5" style="border-style:solid; background:#FFFFE0;"
<code>Array</code> of <code>String</code>s
|+ Parameters
!style="background:#CC9900;"|'''Properties'''
|-
|}
:* There are currently no properties.


== Examples ==
== Examples ==
<pre class='sample'>
<pre class='sample'>
GM_log(GM_listValues());
GM_log(GM_listValues());
</pre>
</pre>


An array of values used by a script:
An array of all values used by a script:
<pre class='sample-good'>
var vals = new Array();
for each(var val in GM_listValues())
    vals.push(GM_getValue(val));
</pre>


Equivalent:
<pre class='sample'>
<pre class='sample-good'>
var vals = [];
var vals = GM_listValues().map(GM_getValue);
for each (var val in GM_listValues()) {
  vals.push(GM_getValue(val));
}
</pre>
</pre>


== See Also ==
== See Also ==
* [[GM_getValue]]
* [[GM_getValue]]
* [[GM_setValue]]
* [[GM_setValue]]

Revision as of 16:27, 8 February 2010


Description

This method retrieves an array of preference names that this script has stored. See GM_setValue for details on the storage of these values.

Syntax

function GM_listValues( )

Compatibility: Greasemonkey 0.8.1+

Arguments

None.

Returns

Array of Strings

Examples

GM_log(GM_listValues());

An array of all values used by a script:

var vals = [];
for each (var val in GM_listValues()) {
  vals.push(GM_getValue(val));
}

See Also