<?xml version="1.0" encoding="UTF-8"?>
<!--
 * Scilab ( https://www.scilab.org/ ) - This file is part of Scilab
 * Copyright (C) - INRIA
 * Copyright (C) 2012 - 2016 - Scilab Enterprises
 * Copyright (C) 2018 - Samuel GOUGEON
 *
 * This file is hereby licensed under the terms of the GNU GPL v2.0,
 * pursuant to article 5.3.4 of the CeCILL v.2.1.
 * This file was originally licensed under the terms of the CeCILL v2.1,
 * and continues to be available under such terms.
 * For more information, see the COPYING file which you should have received
 * along with this program.
 *
 -->
<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">
    <refnamediv>
        <refname>error</refname>
        <refpurpose>エラーメッセージ</refpurpose>
    </refnamediv>
    <refsynopsisdiv>
        <title>呼出し手順</title>
        <synopsis>
            error(message)
            error(message, n)
            error(n, message)
        </synopsis>
    </refsynopsisdiv>
    <refsection>
        <title>引数</title>
        <variablelist>
            <varlistentry>
                <term>message</term>
                <listitem>
                    <para>文字列または文字列のベクトル. 表示されるエラーメッセージ.</para>
                </listitem>
            </varlistentry>
            <varlistentry>
                <term>n</term>
                <listitem>
                    <para>整数. エラーメッセージの番号</para>
                </listitem>
            </varlistentry>
        </variablelist>
    </refsection>
    <refsection>
        <title>説明</title>
        <para>
            <literal>error</literal> 関数によりエラーメッセージを発行でき,
            エラーを処理できます.
            デフォルトで <literal>error</literal> は実行を停止し,
            プロンプトレベルに復帰します.
            このデフォルト動作は,<literal>errcatch</literal> または
            <literal>execstr(…,'errcatch')</literal> 関数により変更できます.
        </para>
        <para>
            <literal>error(message)</literal> は<literal>message</literal>の文字列を
            出力します. エラーメッセージの番号は 10000 となります.
        </para>
        <para>
            <literal>error(message,n)</literal> は
            <literal>message</literal>の文字列を出力します.
            エラーメッセージの番号は<literal>n</literal>で指定されます.
        </para>
        <para>
            エラーメッセージのリストおよび対応するエラー番号については
            <link linkend="error_table">error_table</link> を参照ください.
        </para>
    </refsection>
    <refsection>
        <title>例</title>
        <programlisting role="example"><![CDATA[
function test(a)
    if argn(2)~=1
        msg = gettext("%s: Wrong number of input arguments: %d expected.\n")
        error(msprintf(msg, "test", 1))
    end
endfunction
function myfun()
    a = 1;
    test()
endfunction

// ----------

error(['A multi line' 'error message'])
error(500, 'Error: my error message')
[m, n] = lasterror()

test()
myfun()
    ]]></programlisting>
    <screen><![CDATA[
--> error(['A multi line' 'error message'])

A multi line
error message

--> error(500, 'Error: my error message')

Error: my error message

--> [m, n] = lasterror()
 n  =
   500.
 m  =
 Error: my error message


--> test()
関数の     4 行目 test

test: 入力引数の数が間違っています: 1 個の引数を指定してください.
--> myfun()
関数の     4 行目 test
関数の     3 行目 myfun

test: 入力引数の数が間違っています: 1 個の引数を指定してください.
]]></screen>
    </refsection>
    <refsection role="see also">
        <title>参照</title>
        <simplelist type="inline">
            <member>
                <link linkend="lasterror">lasterror</link>
            </member>
            <member>
                <link linkend="error_table">error_table</link>
            </member>
            <member>
                <link linkend="gettext">gettext</link>
            </member>
            <member>
                <link linkend="warning">warning</link>
            </member>
            <member>
                <link linkend="try">try</link>
            </member>
            <member>
                <link linkend="execstr">execstr</link>
            </member>
            <member>
                <link linkend="where">where</link>
            </member>
        </simplelist>
    </refsection>
    <refsection>
        <title>履歴</title>
        <revhistory>
            <revision>
                <revnumber>5.0.0</revnumber>
                <revremark>
                    <literal>error(n, message)</literal> syntax introduced.
                </revremark>
            </revision>
            <revision>
                <revnumber>5.4.0</revnumber>
                <revremark>
                    <literal>error</literal> 関数は入力引数として文字列ベクトルを受け付けます.
                </revremark>
            </revision>
            <revision>
                <revnumber>6.0.0</revnumber>
                <revremark>
                    The <literal>error(n)</literal> and <literal>error(n, pos)</literal> syntaxes
                    are no longer supported: Providing an explicit error message is now mandatory.
                    There is no longer any absolute error identifier.
                </revremark>
            </revision>
        </revhistory>
    </refsection>
</refentry>
