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

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


#line 10 "dk4statd.ctr"

/**	@file
	File statistics (using stat() and
	lstat() functions, dkChar).

	For a portable (both Windows and non-Windows) check whether a file
	is a symbolic link, reparse point... use the dk4_file_info_t
	data type from dk4fileit.h and the functions from dk4filei.h.

	CRT on Windows: Required.
*/

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

#ifndef	DK4STATT_H_INCLUDED
#if DK4_BUILDING_DKTOOLS4
#include "dk4statt.h"
#else
#include <dktools-4/dk4statt.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

/**	Retrieve information about a file using stat/stat64/_stat64.
	@param	dst	Structure to fill with information.
	@param	path	File name.
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 on error.
	
	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if dst or path is NULL,
	- DK4_E_SYSTEM<br>
	  with errno value stored in iDetails1 if the stat() function fails.
*/
int
dk4stat(dk4_stat_t *dst, const dkChar *path, dk4_er_t *erp);

/**	Retrieve information about a file using lstat/lstat64.
	@param	dst	Structure to fill with information.
	@param	path	File name.
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 on error.
	
	Error codes:
	- DK4_E_NOT_SUPPORTED<br>
	  if there is no support for lstat(),
	- DK4_E_INVALID_ARGUMENTS<br>
	  if dst or path is NULL,
	- DK4_E_SYSTEM<br>
	  with errno value stored in iDetails1 if lstat() fails.
*/
int
dk4stat_l(dk4_stat_t *dst, const dkChar *path, dk4_er_t *erp);

#ifdef __cplusplus
}
#endif



#endif