add_param : Second output argument tagged as obsolete.
[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,err] = 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             <varlistentry>
54                 <term>err</term>
55                 <listitem>
56                     <para>an error flag which is set to %T if list_name is not of type plist (this list has not been initialized by a call to init_param).
57                     </para>
58                     <caution>
59                         This argument is obsolete and will be removed in Scilab 5.5.1.
60                     </caution>
61                 </listitem>
62             </varlistentry>
63         </variablelist>
64     </refsection>
65     <refsection>
66         <title>Description</title>
67         <para>
68             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.
69         </para>
70     </refsection>
71     <refsection>
72         <title>Examples</title>
73         <programlisting role="example"><![CDATA[
74 mylist = init_param();
75 mylist = add_param(mylist,'minbound',[0 0 0]);
76  ]]></programlisting>
77     </refsection>
78     <refsection role="see also">
79         <title>See Also</title>
80         <simplelist type="inline">
81             <member>
82                 <link linkend="init_param">init_param</link>
83             </member>
84             <member>
85                 <link linkend="set_param">set_param</link>
86             </member>
87             <member>
88                 <link linkend="get_param">get_param</link>
89             </member>
90             <member>
91                 <link linkend="remove_param">remove_param</link>
92             </member>
93             <member>
94                 <link linkend="is_param">is_param</link>
95             </member>
96         </simplelist>
97     </refsection>
98     <refsection>
99         <title>History</title>
100         <revhistory>
101             <revision>
102                 <revnumber>5.5.0</revnumber>
103                 <revremark>Second output argument (err) tagged as obsolete.</revremark>
104             </revision>
105         </revhistory>
106     </refsection>
107 </refentry>