improve the documentation of the parameters module
[scilab.git] / scilab / modules / parameters / help / en_US / get_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="get_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>get_param</refname>
26
27     <refpurpose>Get the value of a parameter in a parameter list</refpurpose>
28   </refnamediv>
29
30   <refsynopsisdiv>
31     <title>Calling Sequence</title>
32
33     <synopsis>[res,err] = get_param(list_name,param_name,default_value)</synopsis>
34   </refsynopsisdiv>
35
36   <refsection>
37     <title>Parameters</title>
38
39     <variablelist>
40       <varlistentry>
41         <term>list_name</term>
42
43         <listitem>
44           <para>the list of parameters. This list must have been initialized
45           by a call to init_param.</para>
46         </listitem>
47       </varlistentry>
48
49       <varlistentry>
50         <term>param_name</term>
51
52         <listitem>
53           <para>a string. The name of the parameter to be add in the list of
54           parameters.</para>
55         </listitem>
56       </varlistentry>
57
58       <varlistentry>
59         <term>default_value</term>
60
61         <listitem>
62           <para>the default value to be stored in the parameter if param_name
63           has not been found.</para>
64         </listitem>
65       </varlistentry>
66
67       <varlistentry>
68         <term>res</term>
69
70         <listitem>
71           <para>the value of the parameter. If the parameter doesn't exist,
72           res = [].</para>
73         </listitem>
74       </varlistentry>
75
76       <varlistentry>
77         <term>err</term>
78
79         <listitem>
80           <para>an error flag which is set to %T if list_name is not of type
81           plist (this list hasn't been initialized by a call to
82           init_param).</para>
83         </listitem>
84       </varlistentry>
85     </variablelist>
86   </refsection>
87
88   <refsection>
89     <title>Description</title>
90         <para>This function returns the value of the parameter param_name in a
91         parameter list. If the err output parameter is not present, when an
92         error occurs, a message is printed in the console.</para>
93   </refsection>
94
95   <refsection>
96     <title>Examples</title>
97
98     <programlisting role="example">
99 mylist = init_param();
100 mylist = add_param(mylist,'minbound',[0 0 0]);
101 disp(get_param(mylist,'minbound',-[1 1 1]));
102 disp(get_param(mylist,'maxbound', [1 1 1]));
103  </programlisting>
104   </refsection>
105
106   <refsection>
107     <title>See Also</title>
108
109     <simplelist type="inline">
110       <member><link linkend="init_param"> init_param </link></member>
111
112       <member><link linkend="set_param"> set_param </link></member>
113
114       <member><link linkend="add_param"> add_param </link></member>
115
116       <member><link linkend="remove_param"> remove_param </link></member>
117
118       <member><link linkend="is_param"> is_param </link></member>
119     </simplelist>
120   </refsection>
121
122   <refsection>
123     <title>Authors</title>
124
125     <variablelist>
126       <varlistentry>
127         <term>collette</term>
128
129         <listitem>
130           <para>ycollet@freesurf.fr</para>
131         </listitem>
132       </varlistentry>
133     </variablelist>
134   </refsection>
135 </refentry>