add_param : useless output argument removed.
[scilab.git] / scilab / modules / parameters / help / ja_JP / add_param.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) DIGITEO 2008-2010 - Yann COLLETTE
5  *
6  * This file must be used under the terms of the CeCILL.
7  * This source file is licensed as described in the file COPYING, which
8  * you should have received as part of this distribution.  The terms
9  * are also available at
10  * http://www.cecill.info/licences/Licence_CeCILL_V2.1-en.txt
11  *
12  -->
13 <refentry xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svg="http://www.w3.org/2000/svg" xmlns:mml="http://www.w3.org/1998/Math/MathML" xmlns:db="http://docbook.org/ns/docbook" xmlns:scilab="http://www.scilab.org" xml:lang="ja" xml:id="add_param">
14     <refnamediv>
15         <refname>add_param</refname>
16         <refpurpose>パラメータリストにパラメータを追加</refpurpose>
17     </refnamediv>
18     <refsynopsisdiv>
19         <title>呼び出し手順</title>
20         <synopsis>param_list = add_param(list_name,param_name,param_value)</synopsis>
21     </refsynopsisdiv>
22     <refsection>
23         <title>引数</title>
24         <variablelist>
25             <varlistentry>
26                 <term>list_name</term>
27                 <listitem>
28                     <para>パラメータのリスト. このリストはinit_paramにより
29                         初期化されている必要があります.
30                     </para>
31                 </listitem>
32             </varlistentry>
33             <varlistentry>
34                 <term>param_name</term>
35                 <listitem>
36                     <para>文字列. パラメータのリストに追加されるパラメータの名前.
37                     </para>
38                 </listitem>
39             </varlistentry>
40             <varlistentry>
41                 <term>param_value</term>
42                 <listitem>
43                     <para>パラメータparam_nameの値. このパラメータはオプションです.
44                         このパラメータの値は set_param をコールすることにより
45                         設定可能です.
46                     </para>
47                 </listitem>
48             </varlistentry>
49             <varlistentry>
50                 <term>param_list</term>
51                 <listitem>
52                     <para>更新後のパラメータのリスト.
53                     </para>
54                 </listitem>
55             </varlistentry>
56         </variablelist>
57     </refsection>
58     <refsection>
59         <title>説明</title>
60         <para>
61             この関数は,パラメータのリストに新しいパラメータを作成します.
62             このパラメータの値は,この関数またはset_paramをコールすることにより
63             設定できます.
64         </para>
65     </refsection>
66     <refsection>
67         <title>例</title>
68         <programlisting role="example"><![CDATA[
69 mylist = init_param();
70 mylist = add_param(mylist,'minbound',[0 0 0]);
71  ]]></programlisting>
72     </refsection>
73     <refsection role="see also">
74         <title>参照</title>
75         <simplelist type="inline">
76             <member>
77                 <link linkend="init_param">init_param</link>
78             </member>
79             <member>
80                 <link linkend="set_param">set_param</link>
81             </member>
82             <member>
83                 <link linkend="get_param">get_param</link>
84             </member>
85             <member>
86                 <link linkend="remove_param">remove_param</link>
87             </member>
88             <member>
89                 <link linkend="is_param">is_param</link>
90             </member>
91         </simplelist>
92     </refsection>
93 </refentry>