improve the documentation of the parameters module
[scilab.git] / scilab / modules / parameters / help / en_US / remove_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="remove_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>remove_param</refname>
26
27     <refpurpose>Remove a parameter and its associated value from a list of
28     parameters</refpurpose>
29   </refnamediv>
30
31   <refsynopsisdiv>
32     <title>Calling Sequence</title>
33
34     <synopsis>[param_list,err] = remove_param(list_name,param_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>param_name</term>
52
53         <listitem>
54           <para>a string. The name of the parameter to be removed from the
55           list of parameters. If the parameter doesn't exist, nothing
56           happens.</para>
57         </listitem>
58       </varlistentry>
59
60       <varlistentry>
61         <term>param_list</term>
62
63         <listitem>
64           <para>the updated list of parameters.</para>
65         </listitem>
66       </varlistentry>
67
68       <varlistentry>
69         <term>err</term>
70
71         <listitem>
72           <para>an error flag which is set to %T if list_name is not of type
73           plist (this list hasn't been initialized by a call to
74           init_param).</para>
75         </listitem>
76       </varlistentry>
77     </variablelist>
78   </refsection>
79
80   <refsection>
81     <title>Description</title>
82         <para>This function allows to remove a parameter and its associated
83         value from a list of parameters. If the err output parameter is not
84         present, when an error occurs, a message is printed in the
85         console.</para>
86   </refsection>
87
88   <refsection>
89     <title>Examples</title>
90
91     <programlisting role="example">
92    mylist = init_param();
93    mylist = add_param(mylist,'minbound',[0 0 0]);
94    mylist = add_param(mylist,'maxbound',[0 0 0]);
95    mylist = remove_param(mylist,'minbound');
96   </programlisting>
97   </refsection>
98
99   <refsection>
100     <title>See Also</title>
101
102     <simplelist type="inline">
103       <member><link linkend="init_param"> init_param </link></member>
104
105       <member><link linkend="set_param"> set_param </link></member>
106
107       <member><link linkend="get_param"> get_param </link></member>
108
109       <member><link linkend="add_param"> add_param </link></member>
110
111       <member><link linkend="is_param"> is_param </link></member>
112     </simplelist>
113   </refsection>
114
115   <refsection>
116     <title>Authors</title>
117
118     <variablelist>
119       <varlistentry>
120         <term>collette</term>
121
122         <listitem>
123           <para>ycollet@freesurf.fr</para>
124         </listitem>
125       </varlistentry>
126     </variablelist>
127   </refsection>
128 </refentry>