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

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


#line 10 "dk4membs.ctr"

/**	@file	dk4membs.h	Save buffer data to stream.
*/

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

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

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


#ifdef __cplusplus
extern "C" {
#endif

/**	Save buffer contents to file.
	@param	strm	Output stream.
	@param	mbptr	Buffer containing data to write.
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 on error.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if strm or mbptr is NULL,
	- DK4_E_WRITE_FAILED<br>
	  if writing one ore multiple bytes to the stream failed,
	- DK4_E_FLUSH_FAILED<br>
	  if flusing data downwards failed.
*/
int
dk4membuf_to_stream(
	dk4_stream_t		*strm,
	dk4_membuf_t	const	*mbptr,
	dk4_er_t		*erp
);

#ifdef __cplusplus
}
#endif




#endif