octave_packages/m/time/asctime.m

   1 ## Copyright (C) 1995-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 {Function File} {} asctime (@var{tm_struct})
  21 ## Convert a time structure to a string using the following
  22 ## format: "ddd mmm mm HH:MM:SS yyyy".  For example:
  23 ##
  24 ## @example
  25 ## @group
  26 ## asctime (localtime (time ()))
  27 ##      @result{} "Mon Feb 17 01:15:06 1997"
  28 ## @end group
  29 ## @end example
  30 ##
  31 ## This is equivalent to @code{ctime (time ())}.
  32 ## @seealso{ctime, localtime, time}
  33 ## @end deftypefn
  34
  35 ## Author: jwe
  36
  37 function retval = asctime (tm_struct)
  38
  39   if (nargin != 1)
  40     print_usage ();
  41   endif
  42
  43   retval = strftime ("%a %b %d %H:%M:%S %Y\n", tm_struct);
  44
  45 endfunction
  46
  47
  48 %!test
  49 %! t = time ();
  50 %! assert(strcmp (asctime (localtime (t)), ctime (t)));
  51
  52 %!error asctime ();
  53 %!error asctime (1, 2);
  54