add_param : useless output argument removed.
[scilab.git] / scilab / modules / parameters / help / en_US / add_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) DIGITEO 2008-2010 - Yann COLLETTE
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.1-en.txt
11  *
12  -->
13 <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" xmlns:scilab="http://www.scilab.org" xml:lang="en" xml:id="add_param">
14     <refnamediv>
15         <refname>add_param</refname>
16         <refpurpose>Add a parameter to a list of parameters </refpurpose>
17     </refnamediv>
18     <refsynopsisdiv>
19         <title>Calling Sequence</title>
20         <synopsis>param_list = add_param(list_name,param_name,param_value)</synopsis>
21     </refsynopsisdiv>
22     <refsection>
23         <title>Arguments</title>
24         <variablelist>
25             <varlistentry>
26                 <term>list_name</term>
27                 <listitem>
28                     <para>the list of parameters. This list must have been initialize by a call to init_param.
29                     </para>
30                 </listitem>
31             </varlistentry>
32             <varlistentry>
33                 <term>param_name</term>
34                 <listitem>
35                     <para>a string. The name of the parameter to be added in the list of parameters.
36                     </para>
37                 </listitem>
38             </varlistentry>
39             <varlistentry>
40                 <term>param_value</term>
41                 <listitem>
42                     <para>the value associated to the parameter param_name. This parameter is optional. You can set the value of this parameter via a call to set_param.
43                     </para>
44                 </listitem>
45             </varlistentry>
46             <varlistentry>
47                 <term>param_list</term>
48                 <listitem>
49                     <para>the updated list of parameters.
50                     </para>
51                 </listitem>
52             </varlistentry>
53         </variablelist>
54     </refsection>
55     <refsection>
56         <title>Description</title>
57         <para>
58             This function creates a new parameter in a list of parameters. You can set the value of the parameter using this function or you can set it via a call to set_param.
59         </para>
60     </refsection>
61     <refsection>
62         <title>Examples</title>
63         <programlisting role="example"><![CDATA[
64 mylist = init_param();
65 mylist = add_param(mylist,'minbound',[0 0 0]);
66  ]]></programlisting>
67     </refsection>
68     <refsection role="see also">
69         <title>See Also</title>
70         <simplelist type="inline">
71             <member>
72                 <link linkend="init_param">init_param</link>
73             </member>
74             <member>
75                 <link linkend="set_param">set_param</link>
76             </member>
77             <member>
78                 <link linkend="get_param">get_param</link>
79             </member>
80             <member>
81                 <link linkend="remove_param">remove_param</link>
82             </member>
83             <member>
84                 <link linkend="is_param">is_param</link>
85             </member>
86         </simplelist>
87     </refsection>
88     <refsection>
89         <title>History</title>
90         <revhistory>
91             <revision>
92                 <revnumber>5.5.0</revnumber>
93                 <revremark>Second output argument (err) tagged as obsolete.</revremark>
94             </revision>
95             <revision>
96                 <revnumber>5.5.1</revnumber>
97                 <revremark>Second output argument removed.</revremark>
98             </revision>
99         </revhistory>
100     </refsection>
101 </refentry>