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

#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
#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

/**	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