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>設定値を取得 <emphasis role="bold">（非推奨）</emphasis></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         <warning>
  59             <literal>getPreferencesValue()</literal> is obsolete. It is cloned into
  60             <code>xmlGetValues()</code>. It will be removed from Scilab 6.1.x
  61         </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 getPreferencesValue("//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="xmlGetValues">xmlGetValues</link>
 119             </member>
 120             <member>
 121                 <link linkend="xmlSetValues">xmlSetValues</link>
 122             </member>
 123         </simplelist>
 124     </refsection>
 125     <refsection role="history">
 126         <title>History</title>
 127         <revhistory>
 128             <revision>
 129                 <revnumber>5.5.0</revnumber>
 130                 <revdescription>getPreferencesValue() introduced.
 131                 </revdescription>
 132             </revision>
 133             <revision>
 134                 <revnumber>6.0.0</revnumber>
 135                 <revdescription>
 136                     <itemizedlist>
 137                         <listitem>
 138                             XMLsource can now be the path + filename of the preferences file.
 139                         </listitem>
 140                         <listitem>
 141                             A tag with multiple occurrences can now be read.
 142                         </listitem>
 143                     </itemizedlist>
 144                 </revdescription>
 145             </revision>
 146             <revision>
 147                 <revnumber>6.0.2</revnumber>
 148                 <revdescription>getPreferencesValue() is cloned into xmlGetValues(). It is
 149                     declared obsolete and will be removed from Scilab 6.1.x
 150                 </revdescription>
 151             </revision>
 152         </revhistory>
 153     </refsection>
 154 </refentry>