22610f739fcaf44d4d84e916f7a7ba172a65cdcf
[scilab.git] / scilab / modules / parameters / help / en_US / get_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="get_param">
16   <info>
17     <pubdate>23-Aug-2007</pubdate>
18   </info>
19   <refnamediv>
20     <refname>get_param</refname>
21     <refpurpose> Get the value of a parameter in a parameter list </refpurpose>
22   </refnamediv>
23   <refsynopsisdiv>
24     <title>Calling Sequence</title>
25     <synopsis>[res,err] = get_param(list_name,param_name)</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 add in the list of parameters.
41        </para>
42         </listitem>
43       </varlistentry>
44       <varlistentry>
45         <term>res</term>
46         <listitem>
47           <para>the value of the parameter. If the parameter doesn't exist, res = [].
48        </para>
49         </listitem>
50       </varlistentry>
51       <varlistentry>
52         <term>err</term>
53         <listitem>
54           <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).
55        </para>
56         </listitem>
57       </varlistentry>
58     </variablelist>
59   </refsection>
60   <refsection>
61     <title>Description</title>
62     <itemizedlist>
63       <listitem>
64         <para>
65       This function returns the value of the parameter param_name in a parameter list.
66      </para>
67       </listitem>
68     </itemizedlist>
69   </refsection>
70   <refsection>
71     <title>Examples</title>
72     <programlisting role="example"><![CDATA[
73    mylist = init_param();
74    mylist = add_param(mylist,'minbound',[0 0 0]);
75    disp(get_param(mylist,'minbound'));
76   ]]></programlisting>
77   </refsection>
78   <refsection>
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="add_param"> add_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>Authors</title>
100     <variablelist>
101       <varlistentry>
102         <term>collette</term>
103         <listitem>
104           <para>
105     ycollet@freesurf.fr
106     </para>
107         </listitem>
108       </varlistentry>
109     </variablelist>
110   </refsection>
111 </refentry>