5af2dd777bc22662f09fb00f3285057c3f7ea025
[scilab.git] / scilab / modules / parameters / help / en_US / init_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="init_param">
16   <info>
17     <pubdate>23-Aug-2007</pubdate>
18   </info>
19   <refnamediv>
20     <refname>init_param</refname>
21     <refpurpose> Initialize the structure which will handles the parameters list</refpurpose>
22   </refnamediv>
23   <refsynopsisdiv>
24     <title>Calling Sequence</title>
25     <synopsis>ga_list = init_param()</synopsis>
26   </refsynopsisdiv>
27   <refsection>
28     <title>Parameters</title>
29     <variablelist>
30       <varlistentry>
31         <term>ga_list</term>
32         <listitem>
33           <para>an initialized list of parameters (this list is empty and is of type plist).
34        </para>
35         </listitem>
36       </varlistentry>
37     </variablelist>
38   </refsection>
39   <refsection>
40     <title>Description</title>
41     <itemizedlist>
42       <listitem>
43         <para>
44       This function initialize an empty list of parameters. You must initialize the list of parameters before using it.
45      </para>
46       </listitem>
47     </itemizedlist>
48   </refsection>
49   <refsection>
50     <title>Examples</title>
51     <programlisting role="example"><![CDATA[
52    mylist = init_param();
53    mylist = add_param(mylist,'minbound',[0 0 0]);
54   ]]></programlisting>
55   </refsection>
56   <refsection>
57     <title>See Also</title>
58     <simplelist type="inline">
59       <member>
60         <link linkend="add_param"> add_param </link>
61       </member>
62       <member>
63         <link linkend="set_param"> set_param </link>
64       </member>
65       <member>
66         <link linkend="get_param"> get_param </link>
67       </member>
68       <member>
69         <link linkend="remove_param"> remove_param </link>
70       </member>
71       <member>
72         <link linkend="is_param"> is_param </link>
73       </member>
74     </simplelist>
75   </refsection>
76   <refsection>
77     <title>Authors</title>
78     <variablelist>
79       <varlistentry>
80         <term>collette</term>
81         <listitem>
82           <para>
83     ycollet@freesurf.fr
84     </para>
85         </listitem>
86       </varlistentry>
87     </variablelist>
88   </refsection>
89 </refentry>