summaryrefslogtreecommitdiff
path: root/support/dktools/dk4ufiwc.h
blob: a86407553aa7be7dd3a8c5ee784e1aec91aa78c5 (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
121
122
123
124
125
126
/*
	WARNING: This file was generated by dkct.
	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: dk4ufiwc.ctr
*/

/*
Copyright (C) 2015-2017, Dirk Krause

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice,
  this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above opyright notice,
  this list of conditions and the following disclaimer in the documentation
  and/or other materials provided with the distribution.
* Neither the name of the author nor the names of contributors may be used
  to endorse or promote products derived from this software without specific
  prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED.
IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

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


#line 9 "dk4ufiwc.ctr"

/**	@file
	Obtain unique file identifier for path specified as wchar_t 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 DK4UFI_H_INCLUDED
#include "dk4ufit.h"
#endif

#ifndef DK4ERROR_H_INCLUDED
#include "dk4error.h"
#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_wc(dk4_ufi_t *dptr, const wchar_t *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_wc(dk4_ufi_t *dptr, const wchar_t *fn, dk4_er_t *erp);

#ifdef __cplusplus
}
#endif




#endif