summaryrefslogtreecommitdiff
path: root/support/dktools/dk4ufi08.h
blob: 1833ffe3b21a4a75038fb2bb5ebf06aee068a983 (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
114
115
116
117
118
119
120
/*
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: dk4ufi08.ctr
*/

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


#line 8 "dk4ufi08.ctr"

/**	@file
	Obtain unique file identifier for path specified as char string.
	On non-Windows systems the UFI consists of inode number and
	device number. On Windows systems the volume serial number,
	higher index number and lower index number are used.

	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 DK4UFI_H_INCLUDED
#if DK4_BUILDING_DKTOOLS4
#include "dk4ufit.h"
#else
#include <dktools-4/dk4ufit.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 unique file identifier.
	For symbolic links on non-Windows systems, retrieve
	information about the link target.
	@param	dptr	Destination buffer.
	@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 dptr or fn is NULL,
	- DK4_E_SYSTEM<br>
	  with errno value stored in iDetails1 if the stat() function fails on
	  non-Windows systems,
	- DK4_E_CREATE_FILE_FAILED<br>
	  with GetLastError() result in lDetails1 if the CreateFile() function
	  fails on Windows,
	- DK4_E_FILE_INFORMATION_FAILED<br>
	  with GetLastError() result in lDetails1 if the
	  GetFileInformationByHandle() function fails on Windows.
	- DK4_E_NOT_FOUND<br>
	  if the GetFileAttributes() function fails to retrieve file
	  attributes on Windows.


*/
int
dk4ufi_get_c8(dk4_ufi_t *dptr, const char *fn, dk4_er_t *erp);

/**	Retrieve unique file identifier.
	For symbolic links on non-Windows systems, retrieve
	information about the link.
	@param	dptr	Destination buffer.
	@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 dptr or fn is NULL,
	- DK4_E_SYSTEM<br>
	  with errno value stored in iDetails1 if the lstat() function fails
	  on non-Windows systems,
	- DK4_E_CREATE_FILE_FAILED<br>
	  with GetLastError() result in lDetails1 if the CreateFile() function
	  fails on Windows,
	- DK4_E_FILE_INFORMATION_FAILED<br>
	  with GetLastError() result in lDetails1 if the
	  GetFileInformationByHandle() function fails on Windows.
	- DK4_E_NOT_FOUND<br>
	  if the GetFileAttributes() function fails to retrieve
	  file attributes on Windows.

*/
int
dk4ufi_get_l_c8(dk4_ufi_t *dptr, const char *fn, dk4_er_t *erp);

#ifdef __cplusplus
}
#endif


#endif