octave_packages/m/deprecated/__error_text__.m

   1 ## Copyright (C) 2012 John W. Eaton
   2 ##
   3 ## This file is part of Octave.
   4 ##
   5 ## Octave is free software; you can redistribute it and/or modify it
   6 ## under the terms of the GNU General Public License as published by
   7 ## the Free Software Foundation; either version 3 of the License, or (at
   8 ## your option) any later version.
   9 ##
  10 ## Octave is distributed in the hope that it will be useful, but
  11 ## WITHOUT ANY WARRANTY; without even the implied warranty of
  12 ## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13 ## General Public License for more details.
  14 ##
  15 ## You should have received a copy of the GNU General Public License
  16 ## along with Octave; see the file COPYING.  If not, see
  17 ## <http://www.gnu.org/licenses/>.
  18
  19 ## -*- texinfo -*-
  20 ## @deftypefn {Built-in Function} {[@var{msg}, @var{msgid}] =} __error_text__ (@var{msg}, @var{msgid})
  21 ## This function has been deprecated.  Use @code{lasterr} instead.
  22 ## @seealso{lasterr}
  23 ## @end deftypefn
  24
  25 function [msg, msgid] = __error_text__ (varargin)
  26
  27   persistent warned = false;
  28   if (! warned)
  29     warned = true;
  30     warning ("Octave:deprecated-function",
  31              "__error_text__ is obsolete and will be removed from a future version of Octave, please use lasterr instead");
  32   endif
  33
  34   [msg, msgid] = lasterr (varargin{:});
  35
  36 endfunction