view scripts/deprecated/error_text.m @ 13749:62d1f56b0be7

New nthargout function * nthargout.m: New function. * func.txi (Multiple Return Values): document nthargout. * module.mk (general_FCN_FILES): Add nthargout.m * help.cc (varargin, varargout): Cross-reference other arg functions. * ov-user-fucn.cc (nargin, nargout, isargout): Ditto. * NEWS (3.6): Mention this new file.
author Jordi Gutiérrez Hermoso <jordigh@octave.org>
date Tue, 25 Oct 2011 09:46:38 -0700
parents 6d4c18565de1
children 72c96de7a403
line wrap: on
line source

## Copyright (C) 2011 John W. Eaton
##
## This file is part of Octave.
##
## Octave is free software; you can redistribute it and/or modify it
## under the terms of the GNU General Public License as published by
## the Free Software Foundation; either version 3 of the License, or (at
## your option) any later version.
##
## Octave is distributed in the hope that it will be useful, but
## WITHOUT ANY WARRANTY; without even the implied warranty of
## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
## General Public License for more details.
##
## You should have received a copy of the GNU General Public License
## along with Octave; see the file COPYING.  If not, see
## <http://www.gnu.org/licenses/>.

## -*- texinfo -*-
## @deftypefn {Built-in Function} {[@var{msg}, @var{msgid}] =} error_text (@var{msg}, @var{msgid})
## This function has been deprecated.  Use @code{lasterr} instead.
## @seealso{lasterr}
## @end deftypefn

function [msg, msgid] = error_text (varargin)

  persistent warned = false;
  if (! warned)
    warned = true;
    warning ("Octave:deprecated-function",
             "error_text is obsolete and will be removed from a future version of Octave, please use lasterr instead");
  endif

  [msg, msgid] = lasterr (varargin{:});

endfunction