* Bug 16148: xmlSetValues() <= setPreferencesValue()
[scilab.git] / scilab / modules / preferences / help / ja_JP / setPreferencesValue.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="setPreferencesValue" xml:lang="ja">
17     <refnamediv>
18         <refname>setPreferencesValue</refname>
19         <refpurpose>設定値を設定 <emphasis role="bold">(obsolete)</emphasis></refpurpose>
20     </refnamediv>
21     <refsynopsisdiv>
22         <title>呼び出し手順</title>
23         <synopsis>
24             setPreferencesValue(xpath, key_value [, 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>key_value</term>
41                 <listitem>
42                     <para>2xNの文字列行列, 設定するキーの値.</para>
43                 </listitem>
44             </varlistentry>
45         </variablelist>
46         <variablelist>
47             <varlistentry>
48                 <term>doc</term>
49                 <listitem>
50                     <para>
51                         XMLDoc型のmlist, 設定ファイルのXML文書.
52                     </para>
53                 </listitem>
54             </varlistentry>
55         </variablelist>
56     </refsection>
57     <refsection>
58         <title>説明</title>
59         <warning>
60             <literal>setPreferencesValue()</literal> is obsolete and will be removed in Scilab 6.1.x.
61             Please use <code>xmlSetValues()</code> instead.
62         </warning>
63         <para>
64             設定ファイル(<literal>SCIHOME+'/XConfiguration.xml'</literal>)
65             の属性の値を設定します.
66         </para>
67         <warning>
68             誤って設定を修正するとScilabの動作を改変することになります.
69         </warning>
70         <para>
71             docを指定した場合, 値はこの文書内で探されます.
72             複数のリクエストを実行する必要がある際,
73             同じ設定ファイルを重複してパースすることを避けるために
74             有用です.
75         </para>
76         <para>
77             有効な任意のXPathリクエストを指定できます.
78             例えば,proxy設定を書き込むXPathリクエストは以下のように
79             記述できます:
80         </para>
81         <simplelist type="inline">
82             <member>
83                 <para>
84                     ファイル<literal>SCIHOME+'/XConfiguration.xml'</literal>
85                     を開き,指定したノードにアクセスするためのノード名を
86                     取得します:
87                 </para>
88                 <programlisting role="xml"><![CDATA[
89 <?xml version="1.0" encoding="utf-8" standalone="no"?>
90 <interface height="600" path="1/" version="0.17" width="800">
91     <general title="_(General)">
92     ...
93     </general>
94     <web title="_(Web)">
95         <body>
96             <web command-browser="" command-mailer="" default-browser="true" default-mailer="true"/>
97             <proxy enabled="false" host="" password="" port="" user=""/>
98             <previous-proxy enabled="false" host="" password="" port="" user=""/>
99         </body>
100     </web>
101     ...
102 </interface>
103           ]]></programlisting>
104                 <para>
105                     パスは<literal>"/interface/web/body/proxy"</literal>
106                     (または簡単化するために<literal>"//web/body/proxy"</literal>)
107                     となります.
108                 </para>
109             </member>
110         </simplelist>
111     </refsection>
112     <refsection>
113         <title>例</title>
114         <programlisting role="example"><![CDATA[
115 // カレントの値を取得
116 prev = xmlGetValues("//web/body/proxy", ["enabled", "host", "port"]);
117 setPreferencesValue("//web/body/proxy", ["enabled", "host", "port"; "true", "my.proxy.org", "1234"]);
118 // 確認します
119 xmlGetValues("//web/body/proxy", ["enabled", "host", "port"])
120 // 前の値に戻します
121 setPreferencesValue("//web/body/proxy", ["enabled", "host", "port" ; prev]);
122 xmlGetValues("//web/body/proxy", ["enabled", "host", "port"])
123  ]]></programlisting>
124     </refsection>
125     <refsection role="see also">
126         <title>参照</title>
127         <simplelist type="inline">
128             <member>
129                 <link linkend="xmlGetValues">xmlGetValues</link>
130             </member>
131         </simplelist>
132     </refsection>
133     <refsection role="history">
134         <title>履歴</title>
135         <revhistory>
136             <revision>
137                 <revnumber>6.1.0</revnumber>
138                 <revdescription>
139                     setPreferencesValue() declared obsolete, replaced with xmlSetValues().
140                 </revdescription>
141             </revision>
142         </revhistory>
143     </refsection>
144 </refentry>