c1b59dd0bb905c90467c04b5c21a058f8976a120
[scilab.git] / scilab / modules / preferences / help / ja_JP / getPreferencesValue.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) 2014 - Scilab Enterprises - Calixte DENIZET
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: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="getPreferencesValue" xml:lang="ja">
17     <refnamediv>
18         <refname>getPreferencesValue</refname>
19         <refpurpose>設定値を取得</refpurpose>
20     </refnamediv>
21     <refsynopsisdiv>
22         <title>呼び出し手順</title>
23         <synopsis>
24             getPreferencesValue(xpath, attributes [, doc])
25         </synopsis>
26     </refsynopsisdiv>
27     <refsection>
28         <title>引数</title>
29         <variablelist>
30             <varlistentry>
31                 <term>xpath</term>
32                 <listitem>
33                     <para>文字列,
34                         設定ファイルのノードを取得する
35                         XPathリクエストを表す.
36                     </para>
37                 </listitem>
38             </varlistentry>
39             <varlistentry>
40                 <term>attributes</term>
41                 <listitem>
42                     <para>文字列の行列, 属性名.</para>
43                 </listitem>
44             </varlistentry>
45         </variablelist>
46         <variablelist>
47             <varlistentry>
48                 <term>doc</term>
49                 <listitem>
50                     <para>XMLDoc型のmlist, 設定ファイルのXML文書.
51                     </para>
52                 </listitem>
53             </varlistentry>
54         </variablelist>
55     </refsection>
56     <refsection>
57         <title>説明</title>
58         <para>
59             設定ファイル(<literal>SCIHOME+'/XConfiguration.xml'</literal>)の
60             属性の値を取得します.
61         </para>
62         <para>
63             docを指定した場合, 値はこの文書内で探されます.
64             複数のリクエストを実行する必要がある際,
65             同じ設定ファイルを重複してパースすることを避けるために
66             有用です.
67         </para>
68         <para>
69             有効な任意のXPathリクエストを指定できます.
70             例えば,proxy設定を取得するXPathリクエストは以下のように
71             記述できます:
72         </para>
73         <simplelist type="inline">
74             <member>
75                 <para>
76                     ファイル<literal>SCIHOME+'/XConfiguration.xml'</literal>
77                     を開き,指定したノードにアクセスするためのノード名を
78                     取得します:
79                 </para>
80                 <programlisting role="xml"><![CDATA[
81 <?xml version="1.0" encoding="utf-8" standalone="no"?>
82 <interface height="600" path="1/" version="0.17" width="800">
83     <general title="_(General)">
84     ...
85     </general>
86     <web title="_(Web)">
87         <body>
88             <web command-browser="" command-mailer="" default-browser="true" default-mailer="true"/>
89             <proxy enabled="false" host="" password="" port="" user=""/>
90             <previous-proxy enabled="false" host="" password="" port="" user=""/>
91         </body>
92     </web>
93     ...
94 </interface>
95               ]]></programlisting>
96                 <para>
97                     パスは<literal>"/interface/web/body/proxy"</literal>
98                     (または簡単化するために<literal>"//web/body/proxy"</literal>)
99                     となります.
100                 </para>
101             </member>
102         </simplelist>
103     </refsection>
104     <refsection>
105         <title>例</title>
106         <programlisting role="example"><![CDATA[
107 getPreferencesValue("//web/body/proxy", ["enabled", "host", "port"]);
108  ]]></programlisting>
109     </refsection>
110     <refsection role="see also">
111         <title>参照</title>
112         <simplelist type="inline">
113             <member>
114                 <link linkend="setPreferencesValue">setPreferencesValue</link>
115             </member>
116         </simplelist>
117     </refsection>
118 </refentry>