summaryrefslogtreecommitdiff
path: root/modules/io/help/en_US/getenv.xml
blob: a49d2b53ab20d72a6f7ae8d42783be3e39d98500 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) XXXX-2008 - INRIA
 * 
 * This file must be used under the terms of the CeCILL.
 * This source file is licensed as described in the file COPYING, which
 * you should have received as part of this distribution.  The terms
 * are also available at    
 * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
 *
 -->
<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="en" xml:id="getenv">
    <refnamediv>
        <refname>getenv</refname>
        <refpurpose>get the value of an environment variable</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>Calling Sequence</title>
        <synopsis>env=getenv(str [, defaultReturn] )</synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>Arguments</title>
        <variablelist>
            <varlistentry>
                <term>str</term>
                <listitem>
                    <para>character string specifying environment variable name </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>defaultReturn</term>
                <listitem>
                    <para>
                        an optional character string. When this optional value is used, the function <literal>getenv</literal> returns the value <literal>defaultReturn</literal> when the environment variable <literal>str</literal> is not found.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>env</term>
                <listitem>
                    <para>character string which contain the environment variable value</para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>Description</title>
        <para>
            Return the value of an environment variable if it exists.
        </para>
    </refsection>
    <refsection>
        <title>Examples</title>
        <programlisting role="example"><![CDATA[ 
getenv('SCI')
getenv('FOO','foo') 
 ]]></programlisting>
    </refsection>
</refentry>