<?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: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="getenv">
    <refnamediv>
        <refname>getenv</refname>
        <refpurpose>renvoie la valeur d'une variable d'environnement  </refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Séquence d'appel</title>
        <synopsis>env=getenv(str [, defaultReturn] )</synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Paramètres</title>
        <variablelist>
            <varlistentry>
                <term>str  </term>
                <listitem>
                    <para>
                        chaîne de caractères contenant le nom de la variable d'environnement.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>defaultReturn</term>
                <listitem>
                    <para>
                        chaîne de caractères optionnelle. Quand elle est utilisée, <literal>getenv</literal> renvoie la valeur <literal>defaultReturn</literal> quand la variable d'environnement <literal>str</literal> n'existe pas.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>env  </term>
                <listitem>
                    <para>chaîne de caractères contenant la valeur de la variable d'environnement
                    </para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Description</title>
        <para>
            Renvoie la la valeur d'une variable d'environnement, quand celle-ci existe.
        </para>
    </refsection>
    <refsection>
        <title>Exemples</title>
        <programlisting role="example"><![CDATA[
getenv('SCI')
getenv('FOO','foo')
 ]]></programlisting>
    </refsection>
</refentry>
