[doc] misc. patchs & small improvements
[scilab.git] / scilab / modules / io / help / ja_JP / getenv.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!--
3  * Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
4  * Copyright (C) XXXX-2008 - INRIA
5  *
6  * Copyright (C) 2012 - 2016 - Scilab Enterprises
7  *
8  * This file is hereby licensed under the terms of the GNU GPL v2.0,
9  * pursuant to article 5.3.4 of the CeCILL v.2.1.
10  * This file was originally licensed under the terms of the CeCILL v2.1,
11  * and continues to be available under such terms.
12  * For more information, see the COPYING file which you should have received
13  * along with this program.
14  *
15  -->
16 <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">
17     <refnamediv>
18         <refname>getenv</refname>
19         <refpurpose>環境変数の値を取得</refpurpose>
20     </refnamediv>
21     <refsynopsisdiv>
22         <title>呼び出し手順</title>
23         <synopsis>env=getenv(str [, rep] )</synopsis>
24     </refsynopsisdiv>
25     <refsection>
26         <title>パラメータ</title>
27         <variablelist>
28             <varlistentry>
29                 <term>str</term>
30                 <listitem>
31                     <para>環境変数の名前を指定する文字列</para>
32                 </listitem>
33             </varlistentry>
34             <varlistentry>
35                 <term>rep</term>
36                 <listitem>
37                     <para>
38                         オプションの文字列. このオプションの値を使用する時,
39                         関数 <literal>getenv</literal> は,環境変数 <literal>str</literal>
40                         が見つからない場合に値 <literal>rep</literal> を返します.
41                     </para>
42                 </listitem>
43             </varlistentry>
44             <varlistentry>
45                 <term>env</term>
46                 <listitem>
47                     <para>環境変数の値を有する文字列</para>
48                 </listitem>
49             </varlistentry>
50         </variablelist>
51     </refsection>
52     <refsection>
53         <title>説明</title>
54         <para>
55             指定した環境変数が存在する場合,その値を返します.
56         </para>
57     </refsection>
58     <refsection>
59         <title>例</title>
60         <programlisting role="example"><![CDATA[
61 getenv('SCI')
62 getenv('FOO','foo')
63  ]]></programlisting>
64     </refsection>
65 </refentry>