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

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


#line 10 "dk4getcwdd.ctr"

/**	@file	dk4getcwdd.h	Get current working directoy in dkChar.
*/

#ifndef	DK4CONF_H_INCLUDED
#if DK4_BUILDING_DKTOOLS4
#include "dk4conf.h"
#else
#include <dktools-4/dk4conf.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 current working directory.
	@param	dptr	Destination buffer pointer.
	@param	sz	Buffer size.
	@param	erp	Error report, may be NULL.
	@return	1 on success, 0 on error.
*/
int
dk4getcwd(dkChar *dptr, size_t sz, dk4_er_t *erp);

/**	Find current working directory, return string in newly
	allocated memory.
	@param	erp	Error report, may be NULL.
	@return	Valid pointer to newly allocated memory containing
	the directory name on success, NULL on error.
	On success, use dk4mem_free() to release the memory when done
	with it.

	Error codes:
	- DK4_E_SYSTEM<br>
	  with errno in iDetails if getcwd() or _getcwd() failed
	  or GetLastError() result in iDetails if GetCurrentDirectoryA()
	  failed.
	- DK4_E_INVALID_ARGUMENTS<br>
	  if src is a NULL pointer,
	- DK4_E_MATH_OVERFLOW<br>
	  on mathematical overflow in size calculation,
	- DK4_E_MEMORY<br>
	  if no memory is available.
*/
dkChar *
dk4getcwd_dup(dk4_er_t *erp);

#ifdef __cplusplus
}
#endif



#endif