edb507f280aaa7f28f204473d4b1791ca7d37310
[scilab.git] / scilab / modules / core / help / ja_JP / error_handling / error.xml
1 <?xml version="1.0" encoding="UTF-8"?>
2 <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="error">
3     <refnamediv>
4         <refname>error</refname>
5         <refpurpose>エラーメッセージ</refpurpose>
6     </refnamediv>
7     <refsynopsisdiv>
8         <title>呼出し手順</title>
9         <synopsis>error(message)
10             error(message, n)
11             error(n)
12             error(n, message)
13             error(n, pos)
14         </synopsis>
15     </refsynopsisdiv>
16     <refsection>
17         <title>パラメータ</title>
18         <variablelist>
19             <varlistentry>
20                 <term>message</term>
21                 <listitem>
22                     <para>文字列. 表示されるエラーメッセージ.</para>
23                 </listitem>
24             </varlistentry>
25             <varlistentry>
26                 <term>n</term>
27                 <listitem>
28                     <para>整数. エラーメッセージの番号</para>
29                 </listitem>
30             </varlistentry>
31             <varlistentry>
32                 <term>pos</term>
33                 <listitem>
34                     <para>整数. エラーメッセージのパラメータ</para>
35                 </listitem>
36             </varlistentry>
37         </variablelist>
38     </refsection>
39     <refsection>
40         <title>説明</title>
41         <para>
42             <literal>error</literal> 関数によりエラーメッセージを発行でき,
43             エラーを処理できます.
44             デフォルトで <literal>error</literal> は実行を停止し,
45             プロンプトレベルに復帰します.
46             このデフォルト動作は,<literal>errcatch</literal> または 
47             <literal>execstr(...,'errcatch')</literal> 関数により変更できます.
48         </para>
49         <para>
50             <literal>error(message)</literal> は<literal>message</literal>の文字列を
51             出力します.
52             エラーメッセージの番号は 10000 となります.
53         </para>
54         <para>
55             <literal>error(message,n)</literal> は
56             <literal>message</literal>の文字列を出力します.
57             エラーメッセージの番号は<literal>n</literal>で指定されます.
58             この番号は 10000 より大きい必要があります. 
59         </para>
60         <para>
61             <literal>error(n)</literal> は,
62             エラー番号 <literal>n</literal>の
63             定義済みエラーメッセージを出力します. 
64         </para>
65         <para>いくつかの定義済みエラーメッセージが
66             パラメータを必要とします(
67             <link linkend="error_table">error_table</link>参照).
68             この場合,パラメータの値を指定するために
69             <literal>error(n,pos)</literal>のように
70             引数<literal>pos</literal>を使用する必要があります.
71             その他の場合, <literal>pos</literal>  引数は無視されます.
72         </para>
73         <para> エラーメッセージのリストおよび対応するエラー番号については
74             <link linkend="error_table">error_table</link> を参照ください.
75         </para>
76     </refsection>
77     <refsection>
78         <title>例</title>
79         <programlisting role="example"><![CDATA[error('my error message')
80 error(43)
81 error(52, 3)
82 error(10001, ['A'; 'multi';'line';'error';'message'])
83 lasterror()]]></programlisting>
84     </refsection>
85     <refsection role="see also">
86         <title>参照</title>
87         <simplelist type="inline">
88             <member>
89                 <link linkend="warning">warning</link>
90             </member>
91             <member>
92                 <link linkend="errcatch">errcatch</link>
93             </member>
94             <member>
95                 <link linkend="execstr">execstr</link>
96             </member>
97             <member>
98                 <link linkend="lasterror">lasterror</link>
99             </member>
100             <member>
101                 <link linkend="messagebox">messagebox</link>
102             </member>
103         </simplelist>
104     </refsection>
105 </refentry>