summaryrefslogtreecommitdiff
path: root/support/dktools/dk4rec14.h
blob: ca8c42ba48d989bae520618a5742ca39f2b4de0b (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
/*
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: dk4rec14.ctr
*/

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


#line 9 "dk4rec14.ctr"

/**	@file
	String recoding from 32 bit to ASCII.

	CRT on Windows: Not used.
*/

#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

#ifdef __cplusplus
extern "C" {
#endif

/**	Recode string from 32 bit to ASCII.
	@param	dstb	Destination buffer.
	@param	szdstb	Size of destination buffer (number of bytes).
	@param	src	Source string to convert.
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 on error.
	
	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if src or dstb is NULL or szdstb is 0,
	- DK4_E_BUFFER_TOO_SMALL<br>
	  if dstb is too small,
	- DK4_E_SYNTAX<br>
	  with the number of successfully recoded characters in nelem if a
	  non-recodable character was found.
*/
int
dk4recode_c32_to_ascii(
  char *dstb, size_t szdstb, const dk4_c32_t *src, dk4_er_t *erp
);

#ifdef __cplusplus
}
#endif


#endif