<?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:ns5="http://www.w3.org/1999/xhtml" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:id="return" xml:lang="pt">
    <refnamediv>
        <refname>return</refname>
        <refpurpose>retorna ou pára a execução de uma função e copia algumas de
            suas variáveis locais
        </refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Seqüência de Chamamento </title>
        <synopsis>
            return
            [x1,..,xn] = return(a1,..,an)
        </synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Parâmetros</title>
        <variablelist>
            <varlistentry>
                <term>x</term>
                <listitem>
                    <para>...</para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Descrição</title>
        <para>
            Em uma função, <literal>return</literal> pára a execução da mesma,
            <literal>[..]=return(..)</literal> pára a execução de uma função e põe as
            variáveis locais <literal>ai</literal> no ambiente de chamamento sob os
            nomes de <literal>xi</literal>.
        </para>
        <para>
            No modo <literal>pause</literal> , permite retornar a um nível
            inferior <literal>[..]=return(..)</literal> retorna ao nível inferior e
            põe as variáveis locais <literal>ai</literal> no ambiente de chamamento
            sob os nomes de <literal>xi</literal>.
        </para>
        <para>
            Em um <literal>execstr</literal> chamado por uma função,
            <literal>[..]=return(..)</literal> pára a execução da função e põe as
            variáveis locais <literal>ai</literal> no ambiente de chamamento sob os
            nomes de <literal>xi</literal>.
        </para>
        <para>
            <literal>resume</literal> é equivalente a
            <literal>return</literal>.
        </para>
    </refsection>
    <refsection role="see also">
        <title>Ver Também</title>
        <simplelist type="inline">
            <member>
                <link linkend="abort">abort</link>
            </member>
            <member>
                <link linkend="break">break</link>
            </member>
        </simplelist>
    </refsection>
    <refsection role="history">
        <title>Histórico</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>
