<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( https://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) 2013 - Scilab Enterprises - Paul Bignier
 *
 * Copyright (C) 2012 - 2016 - Scilab Enterprises
 *
 * This file is hereby licensed under the terms of the GNU GPL v2.0,
 * pursuant to article 5.3.4 of the CeCILL v.2.1.
 * This file was originally licensed under the terms of the CeCILL v2.1,
 * and continues to be available under such terms.
 * For more information, see the COPYING file which you should have received
 * along with this program.
 *
 -->
<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">
    <refnamediv>
        <refname>macrovar</refname>
        <refpurpose>variables d'une fonction</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Séquence d'appel</title>
        <synopsis>vars = macrovar(fonction)</synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Paramètres</title>
        <variablelist>
            <varlistentry>
                <term>vars</term>
                <listitem>
                    <para>
                        liste,  <literal>list(in, out, nolocal, called, locals)</literal>.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>fonction</term>
                <listitem>
                    <para>nom de la fonction.</para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Description</title>
        <para>
            Retourne dans une liste l'ensemble des variables utilisées par une fonction.
            <varname>vars</varname> est une liste de cinq vecteurs colonnes de chaînes de caractères:
        </para>
        <simplelist type="inline">
            <member>
                <varname>in</varname>: paramètres d'entrée (<code>vars(1)</code>);
            </member>
            <member>
                <varname>out</varname>: paramètres de sortie (<code>vars(2)</code>);
            </member>
            <member>
                <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>);
            </member>
            <member>
                <varname>called</varname>: noms des fonctions appelées (<code>vars(4)</code>);
            </member>
            <member>
                <varname>locals</varname>: variables locales (<code>vars(5)</code>).
            </member>
        </simplelist>
    </refsection>
    <refsection>
        <title>Exemples</title>
        <programlisting role="example"><![CDATA[
deff('y = f(x1, x2)', 'loc = 1; y = a*x1+x2-loc');
vars = macrovar(f)
 ]]></programlisting>
    </refsection>
    <refsection role="see also">
        <title>Voir Aussi</title>
        <simplelist type="inline">
            <member>
                <link linkend="string">string</link>
            </member>
        </simplelist>
    </refsection>
</refentry>
