<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) INRIA - 2008 - Jean-Baptiste Silvy
 *
 * 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="get_figure_handle">
    <refnamediv>
        <refname>get_figure_handle</refname>
        <refpurpose>
            Retrouve une figure graphique à partir de son identifiant
            <emphasis role="bold">(obsolète)</emphasis>
        </refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Séquence d'appel</title>
        <synopsis>f = get_figure_handle(figure_id)</synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Paramètres</title>
        <variablelist>
            <varlistentry>
                <term>figure_id</term>
                <listitem>
                    <para>Entier, identifiant de la figure à retrouver.</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>f</term>
                <listitem>
                    <para>Handle de la figure correspondante.</para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Description</title>
        <warning>
            <emphasis role="bold">Cette fonction est obsolète</emphasis> et sera retirée de
            Scilab 6.1.x. SVP désormais utiliser <emphasis role="bold">findobj("figure_id",n)</emphasis>.
        </warning>
        <para>
            La function <literal>get_figure_handle</literal> permet de retrouver le handle
            d'une figure graphique à partir de son identifiant. Si une figure avec l'identifiant
            spécifié en argument existe, alors elle est renvoyée par la fonction. Sinon,
            la fonction renvoie une matrice vide.
        </para>
    </refsection>
    <refsection>
        <title>Exemples</title>
        <programlisting role="example"><![CDATA[
// Création de quelques figures.
scf(0);
scf(5);
scf(12);

// Recherche de la figure dont l'identifiant est 5.
f5 = get_figure_handle(5);
// La figure courante est toujours celle d'identifiant 12.
gcf()
// Essaie de retrouver une figure qui n'existe pas.
f42 = get_figure_handle(42);
 ]]></programlisting>
    </refsection>
    <refsection role="see also">
        <title>Voir aussi</title>
        <simplelist type="inline">
            <member>
                <link linkend="set">set</link>
            </member>
            <member>
                <link linkend="get">get</link>
            </member>
            <member>
                <link linkend="gcf">gcf</link>
            </member>
            <member>
                <link linkend="scf">scf</link>
            </member>
            <member>
                <link linkend="graphics_entities">graphics_entities</link>
            </member>
        </simplelist>
    </refsection>
    <refsection role="history">
        <title>Historique</title>
        <revhistory>
            <revision>
                <revnumber>6.1.0</revnumber>
                <revdescription>
                    get_figure_handle(n) est déclarée obsolète.
                    findobj("figure_id",n) la remplace.
                </revdescription>
            </revision>
        </revhistory>
    </refsection>
</refentry>
