85003a2ccc816a6ff93d73c7fd56283805d72b23
[scilab.git] / scilab / modules / parameters / help / en_US / add_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="add_param">
16   <info>
17     <pubdate>23-Aug-2007</pubdate>
18   </info>
19   <refnamediv>
20     <refname>add_param</refname>
21     <refpurpose> Add a parameter to a list of parameters </refpurpose>
22   </refnamediv>
23   <refsynopsisdiv>
24     <title>Calling Sequence</title>
25     <synopsis>[ga_list,err] = add_param(list_name,param_name,param_value)</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>param_name</term>
39         <listitem>
40           <para>a string. The name of the parameter to be added in the list of parameters.
41        </para>
42         </listitem>
43       </varlistentry>
44       <varlistentry>
45         <term>param_value</term>
46         <listitem>
47           <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.
48        </para>
49         </listitem>
50       </varlistentry>
51       <varlistentry>
52         <term>ga_list</term>
53         <listitem>
54           <para>the updated list of parameters.
55        </para>
56         </listitem>
57       </varlistentry>
58       <varlistentry>
59         <term>err</term>
60         <listitem>
61           <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).
62        </para>
63         </listitem>
64       </varlistentry>
65     </variablelist>
66   </refsection>
67   <refsection>
68     <title>Description</title>
69     <itemizedlist>
70       <listitem>
71         <para>
72       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.
73      </para>
74       </listitem>
75     </itemizedlist>
76   </refsection>
77   <refsection>
78     <title>Examples</title>
79     <programlisting role="example"><![CDATA[
80    mylist = init_param();
81    mylist = add_param(mylist,'minbound',[0 0 0]);
82   ]]></programlisting>
83   </refsection>
84   <refsection>
85     <title>See Also</title>
86     <simplelist type="inline">
87       <member>
88         <link linkend="init_param"> init_param </link>
89       </member>
90       <member>
91         <link linkend="set_param"> set_param </link>
92       </member>
93       <member>
94         <link linkend="get_param"> get_param </link>
95       </member>
96       <member>
97         <link linkend="remove_param"> remove_param </link>
98       </member>
99       <member>
100         <link linkend="is_param"> is_param </link>
101       </member>
102     </simplelist>
103   </refsection>
104   <refsection>
105     <title>Authors</title>
106     <variablelist>
107       <varlistentry>
108         <term>collette</term>
109         <listitem>
110           <para>
111     ycollet@freesurf.fr
112     </para>
113         </listitem>
114       </varlistentry>
115     </variablelist>
116   </refsection>
117 </refentry>