* Bug 15433 fixed: getPreferencesValue() => xmlGetValues() in [xml]
[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" 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="xmlGetValues" xml:lang="ja">
17     <refnamediv>
18         <refname>xmlGetValues</refname>
19         <refpurpose>設定値を取得</refpurpose>
20     </refnamediv>
21     <refsynopsisdiv>
22         <title>呼び出し手順</title>
23         <synopsis>
24             xmlGetValues(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                 <warning>This page is not up-to-date. Please consider the english version.</warning>
59         <para>
60             設定ファイル(<literal>SCIHOME+'/XConfiguration.xml'</literal>)の
61             属性の値を取得します.
62         </para>
63         <para>
64             docを指定した場合, 値はこの文書内で探されます.
65             複数のリクエストを実行する必要がある際,
66             同じ設定ファイルを重複してパースすることを避けるために
67             有用です.
68         </para>
69         <para>
70             有効な任意のXPathリクエストを指定できます.
71             例えば,proxy設定を取得するXPathリクエストは以下のように
72             記述できます:
73         </para>
74         <simplelist type="inline">
75             <member>
76                 <para>
77                     ファイル<literal>SCIHOME+'/XConfiguration.xml'</literal>
78                     を開き,指定したノードにアクセスするためのノード名を
79                     取得します:
80                 </para>
81                 <programlisting role="xml"><![CDATA[
82 <?xml version="1.0" encoding="utf-8" standalone="no"?>
83 <interface height="600" path="1/" version="0.17" width="800">
84     <general title="_(General)">
85     ...
86     </general>
87     <web title="_(Web)">
88         <body>
89             <web command-browser="" command-mailer="" default-browser="true" default-mailer="true"/>
90             <proxy enabled="false" host="" password="" port="" user=""/>
91             <previous-proxy enabled="false" host="" password="" port="" user=""/>
92         </body>
93     </web>
94     ...
95 </interface>
96               ]]></programlisting>
97                 <para>
98                     パスは<literal>"/interface/web/body/proxy"</literal>
99                     (または簡単化するために<literal>"//web/body/proxy"</literal>)
100                     となります.
101                 </para>
102             </member>
103         </simplelist>
104     </refsection>
105     <refsection>
106         <title>例</title>
107         <programlisting role="example"><![CDATA[
108 xmlGetValues("//web/body/proxy", ["enabled", "host", "port"]);
109  ]]></programlisting>
110     </refsection>
111     <refsection role="see also">
112         <title>参照</title>
113         <simplelist type="inline">
114             <member>
115                 <link linkend="setPreferencesValue">setPreferencesValue</link>
116             </member>
117         </simplelist>
118     </refsection>
119     <refsection role="history">
120         <title>History</title>
121         <revhistory>
122             <revision>
123                 <revnumber>6.0.2</revnumber>
124                 <revdescription>xmlGetValues() introduced, was formerly getPreferencesValue().
125                 </revdescription>
126             </revision>
127         </revhistory>
128     </refsection>
129 </refentry>