summaryrefslogtreecommitdiff
path: root/support/dktools/dk4time08.h
blob: f9804ca02e19182e5ab01c42872a9b1d5c66afd3 (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
158
159
160
161
162
163
/*
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: dk4time08.ctr
*/

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


#line 9 "dk4time08.ctr"

/**	@file
	Convert timestamp to char string, timestamp either given as set
	of components (year, month, day, hour, minute, second), as
	pointer to struct tm or as dk4_time_t value.

	CRT on Windows: Optional.
*/

#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

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

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

#ifdef __cplusplus
extern "C" {
#endif

/**	Convert timestamp to char string.
	CRT on Windows: Optional.
	@param	dptr	Destination buffer address.
	@param	dsz	Destination buffer size (number of char).
	@param	format	Output format:
			DK4_TIMEFORMAT_DATE_TIME	for sortable date/time
							combination
							yyyy-mm-dd hh:mm:ss
							(default),
			DK4_TIMEFORMAT_DATE_SORTABLE	for sortable date
							yyyy-mm-dd,
			DK4_TIMEFORMAT_DATE_ENGLISH	for English style date
							mm/dd/yyyy,
			DK4_TIMEFORMAT_DATE_GERMAN	for German style date
							dd.mm.yyyy.
	@param	year	Year.
	@param	month	Month (1 to 12).
	@param	mday	Day within month (1 to 31).
	@param	hour	Hour of day (0 to 23).
	@param	min	Minute within hour (0 to 59).
	@param	sec	Second within minute (0 to 59).
	@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_BUFFER_TOO_SMALL<br>
	  if the buffer is too small.

*/
int
dk4time_to_text_c8(
  char			*dptr,
  size_t		 dsz,
  int			 format,
  unsigned short	 year,
  unsigned short	 month,
  unsigned short	 mday,
  unsigned short	 hour,
  unsigned short	 min,
  unsigned short	 sec,
  dk4_er_t		*erp
);

/**	Create text representation for a struct tm.
	CRT on Windows: Required.
	@param	dptr	Destination buffer address.
	@param	dsz	Destination buffer size (number of wchar_t).
	@param	tm	Struct 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_BUFFER_TOO_SMALL<br>
	  if the buffer is too small.
*/
int
dk4time_convert_to_text_c8(
  char *dptr, size_t dsz, const struct tm *tm, dk4_er_t *erp
);

/**	Create text representation for timestamp.
	CRT on Windows: Required.
	@param	dptr	Destination buffer address.
	@param	dsz	Destination buffer size.
	@param	timer	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_BUG<br>
	  if an internal conversion function fails,
	- DK4_E_BUFFER_TOO_SMALL<br>
	  if the buffer is too small.
*/
int
dk4time_as_text_c8(
  char *dptr, size_t dsz, const dk4_time_t *timer, dk4_er_t *erp
);

#ifdef __cplusplus
}
#endif


#endif