mtimeout.1: Use correct dash for number ranges.
[misc] / timemax.h
CommitLineData
300a556d
MW
1/* -*-c-*-
2 *
3 * Return the largest allowable @time_t@ value
4 *
5 * (c) 2016 Mark Wooding
6 */
7
8/*----- Licensing notice --------------------------------------------------*
9 *
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
14 *
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
19 *
20 * You should have received a copy of the GNU General Public License
21 * along with this program; if not, write to the Free Software Foundation,
22 * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23 */
24
25#ifndef TIMEMAX_H
26#define TIMEMAX_H
27
28#ifdef __cplusplus
29 extern "C" {
30#endif
31
32/*----- Header files ------------------------------------------------------*/
33
34#include <time.h>
35
36/*----- Functions provided ------------------------------------------------*/
37
38/* --- @timemax@ --- *
39 *
40 * Arguments: ---
41 *
42 * Returns: The largest value repesentable in an object of type @time_t@.
43 *
44 * Use: For some stupid reason there isn't a @TIME_MAX@ anywhere, and
45 * it's really hard to discover the right value in C. But it's
46 * quite easy in C++, so that's what we do.
47 */
48
49time_t timemax(void);
50
51/*----- That's all, folks -------------------------------------------------*/
52
53#ifdef __cplusplus
54 }
55#endif
56
57#endif