summaryrefslogtreecommitdiff
path: root/support/dktools/dk4symlink.h
blob: f9844ebeaef561b6ae21e75ea83134fb916b8c2b (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
/*
	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: dk4symlink.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 DK4SYMLINK_H_INCLUDED
/** Avoid multiple inclusions. */
#define DK4SYMLINK_H_INCLUDED 1


#line 10 "dk4symlink.ctr"

/**	@file	dk4symlink.h	Find symbolic link target.
*/

#ifndef DK4CONF_H_INCLUDED
#include "dk4conf.h"
#endif

#ifndef DK4TYPES_H_INCLUDED
#include "dk4types.h"
#endif

#ifndef DK4ERROR_H_INCLUDED
#include "dk4error.h"
#endif



#ifdef __cplusplus
extern "C" {
#endif

/**	Find target for symbolic link.
	@param	bptr	Destination buffer pointer.
	@param	szb	Size of destination buffer (number of dkChar).
	@param	fn	File name of link.
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 on error.

	Error codes:
	- DK4_E_INVALID_ARGUMENTS<br>
	  if bptr or fn is NULL or szb is 0,
	- DK4_E_SYSTEM<br>
	  with errno value in iDetails1 if the readlink() function failed
	  on Linux/Unix,
	- DK4_E_BUFFER_TOO_SMALL<br>
	  if the output buffer is too small,
	- DK4_E_NOT_SUPPORTED<br>
	  if no function was found to read a symbolic link target,
	- DK4_E_NOT_FOUND<br>
	  if the CreateFile() or DeviceIoControl() function failed
	  on Windows.
*/
int
dk4symlink_target(dkChar *bptr, size_t szb, const dkChar *fn, dk4_er_t *erp);

#ifdef __cplusplus
}
#endif


#endif