summaryrefslogtreecommitdiff
path: root/modules/io/help/ja_JP/getenv.xml
blob: b5a91c231733ad77a9e820bd2041d387afd0a783 (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
61
62
<?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="ja" xml:id="getenv">
    <refnamediv>
        <refname>getenv</refname>
        <refpurpose>環境変数の値を取得</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>呼び出し手順</title>
        <synopsis>env=getenv(str [, rep] )</synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>パラメータ</title>
        <variablelist>
            <varlistentry>
                <term>str</term>
                <listitem>
                    <para>環境変数の名前を指定する文字列</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>rep</term>
                <listitem>
                    <para>
                        オプションの文字列. このオプションの値を使用する時,
                        関数 <literal>getenv</literal> は,環境変数 <literal>str</literal>
                        が見つからない場合に値 <literal>rep</literal> を返します.
                    </para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>env</term>
                <listitem>
                    <para>環境変数の値を有する文字列</para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>説明</title>
        <para>
            指定した環境変数が存在する場合,その値を返します.
        </para>
    </refsection>
    <refsection>
        <title>例</title>
        <programlisting role="example"><![CDATA[ 
getenv('SCI')
getenv('FOO','foo') 
 ]]></programlisting>
    </refsection>
</refentry>