summaryrefslogtreecommitdiff
path: root/support/dktools/dk4wregd.ctr
blob: e6d6b267d63401475ce80e6f5965a86bc2a1fc10 (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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
%%	options

copyright owner	=	Dirk Krause
copyright year	=	2015-xxxx
license		=	bsd



%%	header

/**	@file
	Access Windows registry, use
	dkChar names.

	CRT on Windows: Optional.
*/

#ifndef DK4CONF_H_INCLUDED
#include "dk4conf.h"
#endif

#ifndef DK4TYPES_H_INCLUDED
#include "dk4types.h"
#endif

#ifndef DK4ERROR_H_INCLUDED
#include "dk4error.h"
#endif

#ifndef DK4WREGK_H_INCLUDED
#include "dk4wregk.h"
#endif

#ifdef __cplusplus
extern "C" {
#endif

/**	Open a registry key.
	@param	pk	Parent key identifier.
	@param	keyname	Name of registry key to open.
	@param	wr	Flag: Open for write access too.
	@param	erp	Error report, may be NULL.
	@return	Pointer to key handle structure on success, NULL on error.
	
	Error codes:
	- DK4_E_NOT_SUPPORTED<br>
	  if the function is run on a non-Windows system,
	- DK4_E_INVALID_ARGUMENTS<br>
	  if pk or keyname is invalid,
	- DK4_E_NOT_FOUND<br>
	  if opening or creating the registry key failed,
	- DK4_E_MEMORY_ALLOCATION_FAILED<br>
	  if memory allocation for the key handle structure failed.
*/
void *
dk4wreg_open_key(int pk, const dkChar *keyname, int wr, dk4_er_t *erp);

/**	Set a string value.
	@param	kptr	Key handle structure.
	@param	name	Entry name.
	@param	val	Entry value.
	@param	expand	Flag: Use REG_EXPAND_SZ (1) or REG_SZ (0).
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 on error.
	
	Error codes:
	- DK4_E_NOT_SUPPORTED<br>
	  when called on non-Windows systems,
	- DK4_E_INVALID_ARGUMENTS<br>
	  if kptr or val is NULL,
	- DK4_E_MATH_OVERFLOW<br>
	  if the name is too long,
	- DK4_E_SYSTEM<br>
	  if RegSetValueExA() failed.
*/
int
dk4wreg_set_string(
  void *kptr, const dkChar *name, const dkChar *val, int expand, dk4_er_t *erp
);

/**	Get string value.
	@param	kptr	Key handle structure.
	@param	name	Entry name.
	@param	bptr	Buffer for result string.
	@param	sz	Result buffer length.
	@param	expand	Pointer to expand flag output variable.
			This variable is set to 1 if the string found
			is of type REG_EXPAND_SZ. The variable is left
			unchanged for REG_SZ.
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 on error.
	
	Error codes:
	- DK4_E_NOT_SUPPORTED<br>
	  when called on non-Windows systems,
	- DK4_E_INVALID_ARGUMENTS<br>
	  if kptr, name, or bptr is NULL or sz is 0,
	- DK4_E_NOT_FOUND<br>
	  if the entry is not found or has 0 length,
	- DK4_E_SYNTAX<br>
	  if the entry is not a string type.
*/
int
dk4wreg_get_string(
  void		*kptr,
  const dkChar	*name,
  dkChar	*bptr,
  size_t	 sz,
  int		*expand,
  dk4_er_t	*erp
);

/**	Set DWORD registry entry.
	@param	kptr	Key handle structure.
	@param	name	Entry name.
	@param	val	Value.
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 on error.
	
	Error codes:
	- DK4_E_NOT_SUPPORTED<br>
	  when called on a non-Windows system,
	- DK4_E_INVALID_ARGUMENTS<br>
	  if kptr is NULL,
	- DK4_E_SYSTEM<br>
	  if RegSetValueExA() failed.
*/
int
dk4wreg_set_dword(
  void *kptr, const dkChar *name, dk4_dword_t val, dk4_er_t *erp
);

/**	Retrieve DWORD value from registry.
	@param	kptr	Key handle structure.
	@param	name	Entry name.
	@param	vptr	Pointer to result variable.
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 on error.
*/
int
dk4wreg_get_dword(
  void		*kptr,
  const dkChar	*name,
  dk4_dword_t	*vptr,
  dk4_er_t	*erp
);

/**	Get string value.
	@param	kptr	Key handle structure.
	@param	name	Entry name.
	@param	dptr	Buffer for result string.
	@param	dsz	Result buffer length, number of dkChar.
	@param	b1	First buffer, used for result from RegQueryValue().
			Should have same size as dptr.
	@param	b1sz	Size of b1, number of dkChar.
	@param	b2	Second buffer, used for result from ExpandEnvironmentStrings.
			Should be 2 characters larger than dptr.
	@param	b2sz	Size of b2, number of dkChar.
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 on error.
	
	Error codes:
	- DK4_E_NOT_SUPPORTED<br>
	  when called on non-Windows systems,
	- DK4_E_INVALID_ARGUMENTS<br>
	  if kptr, name, dptr, b1 or b2 is NULL or
	  dsz, b1sz or b2sz is 0 or out of range,
	- DK4_E_BUFFER_TOO_SMALL<br>
	  if one of the buffers is too small,
	- DK4_E_NOT_FOUND<br>
	  if the entry is not found or has 0 length,
	- DK4_E_SYNTAX<br>
	  if the entry is not a string type.
*/
int
dk4wreg_get_expanded_string(
  void		*kptr,
  const dkChar	*name,
  dkChar	*dptr,
  size_t	 dsz,
  dkChar	*b1,
  size_t	 b1sz,
  dkChar	*b2,
  size_t	 b2sz,
  dk4_er_t	*erp
);

#ifdef __cplusplus
}
#endif


%%	module


#include "dk4conf.h"
#include "dk4types.h"

#if DK4_CHAR_SIZE > 1
#include "dk4wregw.h"
#else
#include "dk4wreg8.h"
#endif

#include "dk4wregd.h"



$!trace-include



void *
dk4wreg_open_key(int pk, const dkChar *keyname, int wr, dk4_er_t *erp)
{
#if DK4_CHAR_SIZE > 1
  return (dk4wreg_open_key_wc(pk, keyname, wr, erp));
#else
  return (dk4wreg_open_key_c8(pk, keyname, wr, erp));
#endif
}



int
dk4wreg_set_string(
  void *kptr, const dkChar *name, const dkChar *val, int expand, dk4_er_t *erp
)
{
#if DK4_CHAR_SIZE > 1
  return (dk4wreg_set_string_wc(kptr, name, val, expand, erp));
#else
  return (dk4wreg_set_string_c8(kptr, name, val, expand, erp));
#endif
}



int
dk4wreg_get_string(
  void		*kptr,
  const dkChar	*name,
  dkChar	*bptr,
  size_t	 sz,
  int		*expand,
  dk4_er_t	*erp
)
{
#if DK4_CHAR_SIZE > 1
  return (dk4wreg_get_string_wc(kptr, name, bptr, sz, expand, erp));
#else
  return (dk4wreg_get_string_c8(kptr, name, bptr, sz, expand, erp));
#endif
}



int
dk4wreg_set_dword(
  void *kptr, const dkChar *name, dk4_dword_t val, dk4_er_t *erp
)
{
#if DK4_CHAR_SIZE > 1
  return (dk4wreg_set_dword_wc(kptr, name, val, erp));
#else
  return (dk4wreg_set_dword_c8(kptr, name, val, erp));
#endif
}



int
dk4wreg_get_dword(
  void		*kptr,
  const dkChar	*name,
  dk4_dword_t	*vptr,
  dk4_er_t	*erp
)
{
#if DK4_CHAR_SIZE > 1
  return (dk4wreg_get_dword_wc(kptr, name, vptr, erp));
#else
  return (dk4wreg_get_dword_c8(kptr, name, vptr, erp));
#endif
}



int
dk4wreg_get_expanded_string(
  void		*kptr,
  const dkChar	*name,
  dkChar	*dptr,
  size_t	 dsz,
  dkChar	*b1,
  size_t	 b1sz,
  dkChar	*b2,
  size_t	 b2sz,
  dk4_er_t	*erp
)
{
#if DK4_CHAR_SIZE > 1
  return (
    dk4wreg_get_expanded_string_wc(
      kptr, name, dptr, dsz, b1, b1sz, b2, b2sz, erp
    )
  );
#else
  return (
    dk4wreg_get_expanded_string_c8(
      kptr, name, dptr, dsz, b1, b1sz, b2, b2sz, erp
    )
  );
#endif
}