<?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="ja" xml:id="get_figure_handle">
    <refnamediv>
        <refname>get_figure_handle</refname>
        <refpurpose>
            指定したIDの図のハンドルを取得
            <emphasis role="bold">(obsolete)</emphasis>
        </refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>呼び出し手順</title>
        <synopsis>f = get_figure_handle(figure_id)</synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>パラメータ</title>
        <variablelist>
            <varlistentry>
                <term>figure_id</term>
                <listitem>
                    <para>整数, 取得する図のID.</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>f</term>
                <listitem>
                    <para>対応する図のハンドル.</para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>説明</title>
        <warning>
            <emphasis role="bold">This function is obsolete</emphasis> and
            will be removed in Scilab 6.1.x. 
            Please use <emphasis role="bold">findobj("figure_id",n)</emphasis> instead.
        </warning>
        <para>
            <literal>get_figure_handle</literal> 関数により
            IDが既知の図のハンドルを取得することが可能です.
            指定したIDを有する図が存在する場合,この関数はそのハンドルを返します.
            それ以外の場合,空の行列を返します.
        </para>
    </refsection>
    <refsection>
        <title>例</title>
        <programlisting role="example"><![CDATA[
// いくつかの図を作成
scf(0);
scf(5);
scf(12);

// ID 5 の図のハンドルを取得
f5 = get_figure_handle(5);
// カレントの図は ID 12の図のままです
gcf()

// 存在しない図を取得
f42 = get_figure_handle(42);
 ]]></programlisting>
    </refsection>
    <refsection role="see also">
        <title>参照</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>履歴</title>
        <revhistory>
            <revision>
                <revnumber>6.1.0</revnumber>
                <revdescription>
                    get_figure_handle(n) is declared obsolete.
                    findobj("figure_id",n) is used instead.
                </revdescription>
            </revision>
        </revhistory>
    </refsection>
</refentry>