<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( https://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) 2006-2008 - INRIA
 * Copyright (C) 2010 - Digiteo - Vincent LIARD
 *
 * 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="fieldnames">
    <refnamediv>
        <refname>fieldnames</refname>
        <refpurpose>récupère le nom des champs d'une tlist, d'une mlist ou
            d'une struct
        </refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Séquence d'appel</title>
        <synopsis>f = fieldnames(lst)</synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Paramètres</title>
        <variablelist>
            <varlistentry>
                <term>lst</term>
                <listitem>
                    <para>Une variable de type tlist, mlist ou struct.</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>f</term>
                <listitem>
                    <para>Un vecteur colonne de chaînes de caractères
                        représentant les noms des champs.
                    </para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Description</title>
        <para>
            La fonction <literal>fieldnames</literal> retourne le nom des
            champs d'une tlist, mlist ou
            struct. <literal>fieldnames</literal> ne fonctionne pas sur le
            type cell.
        </para>
        <para>
            Comme expliqué dans les documentations de <link linkend="rational">rational</link> et
            <link linkend="syslin">syslin</link>, certains objets de Scilab sont construits à partir
            de tlist (ou rlist). Autrement dit, la fonction <function>fieldnames</function> avec ceux-ci en paramètres
            d'entrée va retourner comme résultat la forme générique de ces objets. Par exemple, pour un objet
            de type <link linkend="rational">rational</link>, la fonction va renvoyer "num", "den" et "dt".
        </para>
    </refsection>
    <refsection>
        <title>Exemples</title>
        <programlisting role="example">
            fieldnames(tlist(['listtype', 'f1', 'f2'], [], []))
            fieldnames(mlist(['V', 'key', 'value'], ['a' 'b' ; 'c' 'd'], [1 2 ; 3 4]))
            fieldnames(struct('f1', 25, 'month', 'DEC', 'year', 2006))
            obj.x = 3;
            obj.y = 3;
            fieldnames(obj)
            fieldnames(1/%s)
            fieldnames(tf2ss(1/%s))
        </programlisting>
    </refsection>
    <refsection role="see also">
        <title>Voir aussi</title>
        <simplelist type="inline">
            <member>
                <link linkend="extraction">extraction</link>
            </member>
            <member>
                <link linkend="getfield">getfield</link>
            </member>
            <member>
                <link linkend="tlist">tlist</link>
            </member>
            <member>
                <link linkend="mlist">mlist</link>
            </member>
            <member>
                <link linkend="struct">struct</link>
            </member>
        </simplelist>
    </refsection>
</refentry>
