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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
|
<?xml version="1.0" encoding="UTF-8"?>
<!--
* Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
* Copyright (C) 2014 - Scilab Enterprises - Calixte DENIZET
*
* 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: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">
<refnamediv>
<refname>getPreferencesValue</refname>
<refpurpose>設定値を取得</refpurpose>
</refnamediv>
<refsynopsisdiv>
<title>呼び出し手順</title>
<synopsis>
getPreferencesValue(xpath, attributes [, doc])
</synopsis>
</refsynopsisdiv>
<refsection>
<title>引数</title>
<variablelist>
<varlistentry>
<term>xpath</term>
<listitem>
<para>文字列,
設定ファイルのノードを取得する
XPathリクエストを表す.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>attributes</term>
<listitem>
<para>文字列の行列, 属性名.</para>
</listitem>
</varlistentry>
</variablelist>
<variablelist>
<varlistentry>
<term>doc</term>
<listitem>
<para>XMLDoc型のmlist, 設定ファイルのXML文書.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsection>
<refsection>
<title>説明</title>
<para>
設定ファイル(<literal>SCIHOME+'/XConfiguration.xml'</literal>)の
属性の値を取得します.
</para>
<para>
docを指定した場合, 値はこの文書内で探されます.
複数のリクエストを実行する必要がある際,
同じ設定ファイルを重複してパースすることを避けるために
有用です.
</para>
<para>
有効な任意のXPathリクエストを指定できます.
例えば,proxy設定を取得するXPathリクエストは以下のように
記述できます:
</para>
<simplelist type="inline">
<member>
<para>
ファイル<literal>SCIHOME+'/XConfiguration.xml'</literal>
を開き,指定したノードにアクセスするためのノード名を
取得します:
</para>
<programlisting role="xml"><![CDATA[
<?xml version="1.0" encoding="utf-8" standalone="no"?>
<interface height="600" path="1/" version="0.17" width="800">
<general title="_(General)">
...
</general>
<web title="_(Web)">
<body>
<web command-browser="" command-mailer="" default-browser="true" default-mailer="true"/>
<proxy enabled="false" host="" password="" port="" user=""/>
<previous-proxy enabled="false" host="" password="" port="" user=""/>
</body>
</web>
...
</interface>
]]></programlisting>
<para>
パスは<literal>"/interface/web/body/proxy"</literal>
(または簡単化するために<literal>"//web/body/proxy"</literal>)
となります.
</para>
</member>
</simplelist>
</refsection>
<refsection>
<title>例</title>
<programlisting role="example"><![CDATA[
getPreferencesValue("//web/body/proxy", ["enabled", "host", "port"]);
]]></programlisting>
</refsection>
<refsection role="see also">
<title>参照</title>
<simplelist type="inline">
<member>
<link linkend="setPreferencesValue">setPreferencesValue</link>
</member>
</simplelist>
</refsection>
</refentry>
|
