summaryrefslogtreecommitdiff
path: root/support/dktools/dk4ctime.h
blob: f3713720d7bc968b0faee63dc693b03e6f6d9702 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
/*
Copyright (C) 2015-2020, Dirk Krause
SPDX-License-Identifier: BSD-3-Clause
*/

/*
	WARNING: This file was generated by the dkct program (see
	http://dktools.sourceforge.net/ for details).
	Changes you make here will be lost if dkct is run again!
	You should modify the original source and run dkct on it.
	Original source: dk4ctime.ctr
*/

#ifndef DK4CTIME_H_INCLUDED
/** Avoid multiple inclusions. */
#define DK4CTIME_H_INCLUDED 1


#line 10 "dk4ctime.ctr"

/**	@file
	Retrieve current timestamp (time as visible on the clock),
	compare timestamps, convert to text.
*/

#ifndef DK4CONF_H_INCLUDED
#if DK4_BUILDING_DKTOOLS4
#include "dk4conf.h"
#else
#include <dktools-4/dk4conf.h>
#endif
#endif

#ifndef DK4TYPES_H_INCLUDED
#if DK4_BUILDING_DKTOOLS4
#include "dk4types.h"
#else
#include <dktools-4/dk4types.h>
#endif
#endif

#ifndef DK4ERROR_H_INCLUDED
#if DK4_BUILDING_DKTOOLS4
#include "dk4error.h"
#else
#include <dktools-4/dk4error.h>
#endif
#endif

#if DK4_ON_WINDOWS && (DK4_WIN_AVOID_CRT || DK4_WIN_DENY_CRT)
#ifndef WINDOWS_H_INCLUDED
#include <windows.h>
#define	WINDOWS_H_INCLUDED 1
#endif
#else
#if DK4_HAVE_SYS_TYPES_H
#ifndef SYS_TYPES_H_INCLUDED
#include <sys/types.h>
#define	SYS_TYPES_H_INCLUDED 1
#endif
#endif
#if DK4_TIME_WITH_SYS_TIME
#ifndef SYS_TIME_H_INCLUDED
#include <sys/time.h>
#define	SYS_TIME_H_INCLUDED 1
#endif
#ifndef TIME_H_INCLUDED
#include <time.h>
#define	TIME_H_INCLUDED 1
#endif
#else
#if DK4_HAVE_TIME_H
#ifndef TIME_H_INCLUDED
#include <time.h>
#define	TIME_H_INCLUDED 1
#endif
#else
#if DK4_HAVE_SYS_TIME_H
#ifndef SYS_TIME_H_INCLUDED
#include <sys/time.h>
#define	SYS_TIME_H_INCLUDED 1
#endif
#endif
#endif
#endif
#ifndef DK4TIME_H_INCLUDED
#if DK4_BUILDING_DKTOOLS4
#include "dk4time.h"
#else
#include <dktools-4/dk4time.h>
#endif
#endif
#endif

#if DK4_ON_WINDOWS && (DK4_WIN_AVOID_CRT || DK4_WIN_DENY_CRT)
/**	Time as shown on the clock.
*/
typedef	SYSTEMTIME	dk4_clock_time_t;
#else
/**	Time as shown on the clock.
*/
typedef dk4_time_t	dk4_clock_time_t;
#endif

#ifdef __cplusplus
extern "C" {
#endif

/**	Retrieve current date and time.
	CRT on Windows: Optional.
	@param	dptr	Result buffer.
	@return	1 on success, 0 on error.
*/
int
dk4clocktime_get(dk4_clock_time_t *dptr);

/**	Compare two timestamps.
	CRT on Windows: Optional.
	@param	l	Left timestamp.
	@param	r	Right timestamp.
	@return	1 if l>r, 0 if l=r, -1 if l<r.
*/
int
dk4clocktime_compare(const dk4_clock_time_t *l, const dk4_clock_time_t *r);

/**	Convert timestamp to text ``yyyy-mm-dd hh:mm:ss''.
	CRT on Windows: Optional.
	@param	dptr	Result buffer address.
	@param	dsz	Result buffer size (number of dkChar).
	@param	clt	Timestamp to convert.
	@param	erp	Error report, may be NULL.
	@return 1 on success, 0 on error.
	
	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if dptr is NULL or dsz is 0,
	- DK4_E_MATH_OVERFLOW<br>
	  if a mathematical overflow occures in a size calculation,
	- DK4_E_BUFFER_TOO_SMALL<br>
	  if the buffer is too small.
*/
int
dk4clocktime_to_text(
  dkChar			*dptr,
  size_t			 dsz,
  const dk4_clock_time_t	*clt,
  dk4_er_t			*erp
);

#ifdef __cplusplus
}
#endif




#endif