<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( https://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) 2008 - INRIA
 *
 * 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="return">
    <refnamediv>
        <refname>return</refname>
        <refpurpose>リターンまたは復旧し,ローカルな変数をコピー</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>呼出し手順</title>
        <synopsis>
            return
            [x1,..,xn] = return(a1,..,an)
        </synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>引数</title>
       <variablelist>
            <varlistentry>
                <term>x1,..,xn</term>
                <listitem>
                    <para>コール側の環境の変数</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>a1,..,an</term>
                <listitem>
                    <para>ローカル変数</para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>説明</title>
        <para>
            関数の中で, <literal>return</literal> は
            関数の実行を停止し,
            <literal>[..]=return(..)</literal> は関数の実行を停止し,
            ローカルな変数 <literal>ai</literal>を呼び出し側の環境の
            変数 <literal>xi</literal> に代入します.
        </para>
        <para>
            <literal>pause</literal> モードでは,上位レベルにリターンすることができ,
            <literal>[..]=return(..)</literal> は上位レベルにリターンし,
            ローカル変数 <literal>ai</literal>を呼び出し側の環境の
            変数 <literal>xi</literal> に代入します.
        </para>
        <para>
            関数からコールされた<literal>execstr</literal>の内部では,
            <literal>[..]=return(..)</literal>はその関数の実行を停止し,
            ローカル変数<literal>ai</literal>を
            呼び出し側の環境の<literal>xi</literal>という名前の変数に代入します.
        </para>
        <para>
            <literal>resume</literal> は <literal>return</literal>と等価です.
        </para>
        <para>
          <note>
	    注意: この機能を使用すると,コードが複雑化する可能性があります.
	    代わりに, <code>function b = foo()</code>構文が推奨されます.
          </note>
        </para>
    </refsection>
    <refsection>
        <title>例</title>
        <programlisting role="example"><![CDATA[
function foo(a)
         a=a+1
         b=resume(a)
         c=52
endfunction

foo(42);
assert_checkequal(b,43)
// c does not exist

 ]]></programlisting>
    </refsection>

    <refsection role="see also">
        <title>参照</title>
        <simplelist type="inline">
            <member>
                <link linkend="abort">abort</link>
            </member>
            <member>
                <link linkend="break">break</link>
            </member>
            <member>
                <link linkend="execstr">execstr</link>
            </member>
            <member>
                <link linkend="resume">resume</link>
            </member>
        </simplelist>
    </refsection>
    <refsection role="history">
        <title>履歴</title>
        <revhistory>
            <revision>
                <revnumber>6.0.0</revnumber>
                <revdescription>
                  <literal>return</literal> is now protected:
                  Assignments like <literal>return=1</literal> are no longer possible.
                </revdescription>
            </revision>
        </revhistory>
    </refsection>
</refentry>
