rom/battclock/resetbattclock.c

   1 /*
   2     Copyright © 1995-2009, The AROS Development Team. All rights reserved.
   3     $Id$
   4
   5     Desc: ResetBattClock()
   6     Lang: english
   7 */
   8 #include "battclock_intern.h"
   9
  10 /*****************************************************************************
  11
  12     NAME */
  13 #include <proto/battclock.h>
  14
  15         AROS_LH0(void, ResetBattClock,
  16
  17 /*  SYNOPSIS */
  18         /* void */
  19
  20 /*  LOCATION */
  21         APTR, BattClockBase, 1, Battclock)
  22
  23 /*  FUNCTION
  24         Reset the system battery-backed-up clock. This will reset the clock
  25         back to 0 seconds (or midnight, 1st Jan 1978).
  26
  27     INPUTS
  28         None.
  29
  30     RESULT
  31         The clock will be reset.
  32
  33     NOTES
  34         This function may do nothing when the battery backed up clock either
  35         doesn't exist, or may not be writable by the operating system.
  36
  37     EXAMPLE
  38
  39     BUGS
  40
  41     SEE ALSO
  42         ReadBattClock(), WriteBattClock()
  43
  44     INTERNALS
  45
  46 *****************************************************************************/
  47 {
  48     AROS_LIBFUNC_INIT
  49
  50     WriteBattClock(0);
  51
  52     AROS_LIBFUNC_EXIT
  53 } /* ResetBattClock */