summaryrefslogtreecommitdiff
path: root/support/dktools/dk3inst.h
blob: 413e073ed0200d8a824dcba6648a8c3886cd84bb (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
/*
Copyright 2020, Dirk Krause. All rights reserved.
SPDX-License-Identifier:	BSD-3-Clause
*/

/**	@file	dk3inst.h	Get installation directory names.
 */

#ifndef DK3_INST_H_INCLUDED
#define DK3_INST_H_INCLUDED 1

#ifndef	DK3CONF_H_INCLUDED
#include "dk3conf.h"
#endif

#ifdef __cplusplus
extern "C" {
#endif

/**	Retrieve one directory name.
* 	@param	i	Index of directory in array.
* 	0=prefix (i.e. /usr), 1=system configuration directory
* 	(i.e. /etc), 2=data root directory (i.e. /usr/share),
* 	3=local state directory (i.e. /var), 4=binaries directory
* 	(i.e. /usr/bin), 5=administrators binaries directory
* 	(i.e. /usr/sbin), 6=library directory (i.e. /usr/lib),
* 	7=include directory (i.e. /usr/include), 8=manual directory
* 	(i.e. /usr/man), 9=..., 10=libexec directory (i.e. /usr/libexec).
* 	@return	The directory name on success, NULL on error.
*/
/*^null^*/
/*^dependent^*/
dkChar const *
dk3inst_get_directory(size_t i) /*^*/ ;

#ifdef __cplusplus
}
#endif

#endif