Format the optional arguments under the control of the template string template using the same rules as the
printf
family of functions (see Formatted Output) and print the resulting message on thestderr
stream. The message is prefixed by the character string ‘error: ’.Calling
error
also sets Octave's internal error state such that control will return to the top level without evaluating any more commands. This is useful for aborting from functions or scripts.If the error message does not end with a new line character, Octave will print a traceback of all the function calls leading to the error. For example, given the following function definitions:
function f () g (); end function g () h (); end function h () nargin == 1 || error ("nargin != 1"); endcalling the function
f
will result in a list of messages that can help you to quickly locate the exact location of the error:f () error: nargin != 1 error: called from: error: error at line -1, column -1 error: h at line 1, column 27 error: g at line 1, column 15 error: f at line 1, column 15If the error message ends in a new line character, Octave will print the message but will not display any traceback messages as it returns control to the top level. For example, modifying the error message in the previous example to end in a new line causes Octave to only print a single message:
function h () nargin == 1 || error ("nargin != 1\n"); end f () error: nargin != 1