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