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

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


#line 10 "dk4delfile.ctr"

/**	@file
	Remove file specified by dkChar text.

	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

#ifdef __cplusplus
extern "C" {
#endif

/**	Remove one file.
	@param	fn	File name.
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 on error.
	
	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if fn is NULL,
	- DK4_E_NOT_SUPPORTED<br>
	  if no system function was found to delete files,
	- DK4_E_UNLINK_FAILED<br>
	  with errno value in idetails if the unlink operation failed,
	- DK4_E_DELETE_FILE_FAILED<br>
	  with GetLastError() value in lDetails1 if the DeleteFile() function
	  failed on Windows.
*/
int
dk4delete_file(const dkChar *fn, dk4_er_t *erp);

#ifdef __cplusplus
}
#endif


#endif