a852e1260306ad8fe30d11a23173047a87ff7e68
[scilab.git] / scilab / modules / parameters / help / en_US / is_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="is_param">
16   <info>
17     <pubdate>23-Aug-2007</pubdate>
18   </info>
19   <refnamediv>
20     <refname>is_param</refname>
21     <refpurpose> Check if a parameter is present in a parameter list </refpurpose>
22   </refnamediv>
23   <refsynopsisdiv>
24     <title>Calling Sequence</title>
25     <synopsis>[res,err] = is_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 result: %T is the parameter is present, %F otherwise.
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 checks if a parameter is present 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(is_param(mylist,'minbound'));
76    disp(is_param(mylist,'maxbound'));
77   ]]></programlisting>
78   </refsection>
79   <refsection>
80     <title>See Also</title>
81     <simplelist type="inline">
82       <member>
83         <link linkend="init_param"> init_param </link>
84       </member>
85       <member>
86         <link linkend="set_param"> set_param </link>
87       </member>
88       <member>
89         <link linkend="get_param"> get_param </link>
90       </member>
91       <member>
92         <link linkend="remove_param"> remove_param </link>
93       </member>
94       <member>
95         <link linkend="add_param"> add_param </link>
96       </member>
97     </simplelist>
98   </refsection>
99   <refsection>
100     <title>Authors</title>
101     <variablelist>
102       <varlistentry>
103         <term>collette</term>
104         <listitem>
105           <para>
106     ycollet@freesurf.fr
107     </para>
108         </listitem>
109       </varlistentry>
110     </variablelist>
111   </refsection>
112 </refentry>