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