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

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


#line 10 "dk4file8.ctr"

/**	@file
	File checks.
*/

#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

/**	Check whether a path exists.
	CRT on Windows: Not used.
	@param	fn	File name.
	@param	erp	Error report, may be NULL.
	@return	1 if file exists, 0 otherwise.
	Note: The function also returns 0 if it fails to obtain information
	about a file, i.e. due to missing permissions...
	
	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if fn is NULL,
	- DK4_E_NOT_FOUND<br>
	  if the specified file was not found or retrieving information
	  failed for other reasons.
*/
int
dk4file_c8_exists(const char *fn, dk4_er_t *erp);

/**	Check whether a path name specifies a regular file.
	CRT on Windows: Not used.
	@param	fn	File name.
	@param	erp	Error report, may be NULL.
	@return	1 for existing regular file, 0 otherwise.
	
	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if fn is NULL,
	- DK4_E_NOT_FOUND<br>
	  if the file does not exist or retrieving the information failed
	  for some reason,
	- none<br>
	  if the path exists but is not a regular file.
*/
int
dk4file_c8_is_regular(const char *fn, dk4_er_t *erp);

/**	Check whether a path name specifies a directory.
	CRT on Windows: Not used.
	@param	fn	File name.
	@param	erp	Error report, may be NULL.
	@return	1 for existing directory, 0 otherwise.
	
	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if fn is NULL,
	- DK4_E_NOT_FOUND<br>
	  if the file does not exist or retrieving the information failed
	  for some reason,
	- none<br>
	  if the path exists but is not a directory.
*/
int
dk4file_c8_is_directory(const char *fn, dk4_er_t *erp);

#ifdef __cplusplus
}
#endif



#endif