* Bug 15380 fixed: argn() page was unclear & uncomplete
[scilab.git] / scilab / modules / functions / help / fr_FR / macrovar.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) 2013 - Scilab Enterprises - Paul Bignier
5  *
6  * Copyright (C) 2012 - 2016 - Scilab Enterprises
7  *
8  * This file is hereby licensed under the terms of the GNU GPL v2.0,
9  * pursuant to article 5.3.4 of the CeCILL v.2.1.
10  * This file was originally licensed under the terms of the CeCILL v2.1,
11  * and continues to be available under such terms.
12  * For more information, see the COPYING file which you should have received
13  * along with this program.
14  *
15  -->
16 <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" xmlns:scilab="http://www.scilab.org" xml:lang="fr" xml:id="macrovar">
17     <refnamediv>
18         <refname>macrovar</refname>
19         <refpurpose>variables d'une fonction</refpurpose>
20     </refnamediv>
21     <refsynopsisdiv>
22         <title>Séquence d'appel</title>
23         <synopsis>vars = macrovar(fonction)</synopsis>
24     </refsynopsisdiv>
25     <refsection>
26         <title>Paramètres</title>
27         <variablelist>
28             <varlistentry>
29                 <term>vars</term>
30                 <listitem>
31                     <para>
32                         liste,  <literal>list(in, out, nolocal, called, locals)</literal>.
33                     </para>
34                 </listitem>
35             </varlistentry>
36             <varlistentry>
37                 <term>fonction</term>
38                 <listitem>
39                     <para>nom de la fonction.</para>
40                 </listitem>
41             </varlistentry>
42         </variablelist>
43     </refsection>
44     <refsection>
45         <title>Description</title>
46         <para>
47             Retourne dans une liste l'ensemble des variables utilisées par une fonction.
48             <varname>vars</varname> est une liste de cinq vecteurs colonnes de chaînes de caractères:
49         </para>
50         <simplelist type="inline">
51             <member>
52                 <varname>in</varname>: paramètres d'entrée (<code>vars(1)</code>);
53             </member>
54             <member>
55                 <varname>out</varname>: paramètres de sortie (<code>vars(2)</code>);
56             </member>
57             <member>
58                 <varname>nolocal</varname>: variables référencées qui ne sont pas définies dans la fonction et qui ne sont pas des fonctions (<code>vars(3)</code>);
59             </member>
60             <member>
61                 <varname>called</varname>: noms des fonctions appelées (<code>vars(4)</code>);
62             </member>
63             <member>
64                 <varname>locals</varname>: variables locales (<code>vars(5)</code>).
65             </member>
66         </simplelist>
67     </refsection>
68     <refsection>
69         <title>Exemples</title>
70         <programlisting role="example"><![CDATA[
71 deff('y = f(x1, x2)', 'loc = 1; y = a*x1+x2-loc');
72 vars = macrovar(f)
73  ]]></programlisting>
74     </refsection>
75     <refsection role="see also">
76         <title>Voir Aussi</title>
77         <simplelist type="inline">
78             <member>
79                 <link linkend="string">string</link>
80             </member>
81         </simplelist>
82     </refsection>
83 </refentry>