improve the documentation of the parameters module
[scilab.git] / scilab / modules / parameters / help / en_US / list_param.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) 2008 - Yann COLLETTE <yann.collette@renault.com>
5  *
6  * This file must be used under the terms of the CeCILL.
7  * This source file is licensed as described in the file COPYING, which
8  * you should have received as part of this distribution.  The terms
9  * are also available at
10  * http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
11  *
12  -->
13 <refentry version="5.0-subset Scilab" xml:id="list_param" xml:lang="en"
14           xmlns="http://docbook.org/ns/docbook"
15           xmlns:xlink="http://www.w3.org/1999/xlink"
16           xmlns:svg="http://www.w3.org/2000/svg"
17           xmlns:ns3="http://www.w3.org/1999/xhtml"
18           xmlns:mml="http://www.w3.org/1998/Math/MathML"
19           xmlns:db="http://docbook.org/ns/docbook">
20   <info>
21     <pubdate>23-Aug-2007</pubdate>
22   </info>
23
24   <refnamediv>
25     <refname>list_param</refname>
26
27     <refpurpose>List all the parameters name in a list of
28     parameters</refpurpose>
29   </refnamediv>
30
31   <refsynopsisdiv>
32     <title>Calling Sequence</title>
33
34     <synopsis>[string_list,err] = list_param(list_name)</synopsis>
35   </refsynopsisdiv>
36
37   <refsection>
38     <title>Parameters</title>
39
40     <variablelist>
41       <varlistentry>
42         <term>list_name</term>
43
44         <listitem>
45           <para>the list of parameters. This list must have been initialize by
46           a call to init_param.</para>
47         </listitem>
48       </varlistentry>
49
50       <varlistentry>
51         <term>string_list</term>
52
53         <listitem>
54           <para>the list of parameters name.</para>
55         </listitem>
56       </varlistentry>
57
58       <varlistentry>
59         <term>err</term>
60
61         <listitem>
62           <para>an error flag which is set to %T if list_name is not of type
63           plist (this list hasn't been initialized by a call to
64           init_param).</para>
65         </listitem>
66       </varlistentry>
67     </variablelist>
68   </refsection>
69
70   <refsection>
71     <title>Description</title>
72         <para>List all the parameters name in a list of parameters. If the err
73         output parameter is not present, when an error occurs, a message is
74         printed in the console.</para>
75   </refsection>
76
77   <refsection>
78     <title>Examples</title>
79
80     <programlisting role="example">
81    mylist = init_param();
82    mylist = add_param(mylist,'minbound',[0 0 0]);
83    mylist = add_param(mylist,'maxbound',[1 1 1]);
84    disp(list_param(mylist));
85   </programlisting>
86   </refsection>
87
88   <refsection>
89     <title>See Also</title>
90
91     <simplelist type="inline">
92       <member><link linkend="init_param"> init_param </link></member>
93
94       <member><link linkend="set_param"> set_param </link></member>
95
96       <member><link linkend="get_param"> get_param </link></member>
97
98       <member><link linkend="remove_param"> remove_param </link></member>
99
100       <member><link linkend="is_param"> is_param </link></member>
101     </simplelist>
102   </refsection>
103
104   <refsection>
105     <title>Authors</title>
106
107     <variablelist>
108       <varlistentry>
109         <term>collette</term>
110
111         <listitem>
112           <para>ycollet@freesurf.fr</para>
113         </listitem>
114       </varlistentry>
115     </variablelist>
116   </refsection>
117 </refentry>