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
|
/*
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: dk4user.ctr
*/
#ifndef DK4USER_H_INCLUDED
/** Avoid multiple inclusions. */
#define DK4USER_H_INCLUDED 1
#line 10 "dk4user.ctr"
/** @file
Get information about user
(login name and home directory).
*/
#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
/** Get users login name.
@param pdst Pointer to destination buffer.
@param szdst Size of destination buffer (number of characters).
@param eff Flag: Retrieve information about effective user.
@param erp Error report, may be NULL.
@return 1 on success, 0 on error.
CRT on Windows: Not used.
Error codes:
- DK4_E_INVALID_ARGUMENTS<br>
if pdst is NULL or szdst is 0,
- DK4_E_NOT_FOUND<br>
if the login name was not found,
- DK4_E_BUFFER_TOO_SMALL<br>
if the buffer is too small for the result.
*/
int
dk4user_get_logname(dkChar *pdst, size_t szdst, int eff, dk4_er_t *erp);
/** Get users home directory.
@param pdst Pointer to destination buffer.
@param szdst Size of destination buffer (number of characters).
@param eff Flag: Retrieve information about effective user.
@param erp Error report, may be NULL.
@return 1 on success, 0 on error.
CRT on Windows: Optional.
Error codes:
- DK4_E_INVALID_ARGUMENTS<br>
if pdst is NULL or szdst is 0,
- DK4_E_NOT_FOUND<br>
if the login name, the user entry or the home
directory was not found,
- DK4_E_MEMORY<br>
if an internal memory allocation failed,
- DK4_E_SYNTAX<br>
if the retrieved registry entry on
Windows is not a string,
- DK4_E_BUFFER_TOO_SMALL<br>
if the pdst buffer or one of the internal buffers
is too small for the result.
*/
int
dk4user_get_homedir(dkChar *pdst, size_t szdst, int eff, dk4_er_t *erp);
#ifdef __cplusplus
}
#endif
#endif
|