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