<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) XXXX-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="getenv" xml:lang="pt">
    <refnamediv>
        <refname>getenv</refname>
        <refpurpose>retorna o valor de uma variável de ambiente</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Seqüência de Chamamento</title>
        <synopsis>env=getenv(str [, rep] )</synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Parâmetros</title>
        <variablelist>
            <varlistentry>
                <term>str</term>
                <listitem>
                    <para>string especificando o nome da variável de ambiente; rep : um
                        string opcional. Quando este valor opcional é usado, a função
                        <literal>getenv</literal> retorna o valor <literal>rep</literal>
                        quando a variável de ambiente <literal>str</literal> não é
                        encontrada.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>env</term>
                <listitem>
                    <para>string que contém o valor da variável de ambiente</para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Descrição</title>
        <para>Retorna o valor de uma variável de ambiente, se existir.</para>
    </refsection>
    <refsection>
        <title>Exemplos</title>
        <programlisting role="example"><![CDATA[
getenv('SCI')
getenv('FOO','foo')
 ]]></programlisting>
    </refsection>
</refentry>
