Minor fixes to comments.
[AROS.git] / rom / battclock / readbattclock.c
bloba69c557dcef62249faee8fc8c53a7b9abc95b65b
1 /*
2 Copyright © 1995-2001, The AROS Development Team. All rights reserved.
3 $Id$
5 Desc: ReadBattClock() function.
6 Lang: english
7 */
8 #include "battclock_intern.h"
10 /*****************************************************************************
12 NAME */
13 #include <proto/battclock.h>
15 AROS_LH0(ULONG, ReadBattClock,
17 /* SYNOPSIS */
18 /* void */
20 /* LOCATION */
21 APTR, BattClockBase, 2, Battclock)
23 /* FUNCTION
24 Return the value stored in the battery back up clock. This value
25 is the number of seconds that have elapsed since midnight on the
26 1st of January 1978 (00:00:00 1.1.1978).
28 If the value of the battery clock is invalid, then the clock will
29 be reset.
31 INPUTS
33 RESULT
34 The number of seconds since 1.1.1978 00:00:00
36 NOTES
38 EXAMPLE
40 BUGS
42 SEE ALSO
43 WriteBattClock(), ResetBattClock()
45 INTERNALS
47 HISTORY
49 *****************************************************************************/
51 AROS_LIBFUNC_INIT
53 #warning battclock.resource functionality not added
54 return 0;
56 AROS_LIBFUNC_EXIT
57 } /* ReadBattClock */