/* 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 #endif #endif #ifndef DK4TYPES_H_INCLUDED #if DK4_BUILDING_DKTOOLS4 #include "dk4types.h" #else #include #endif #endif #ifndef DK4ERROR_H_INCLUDED #if DK4_BUILDING_DKTOOLS4 #include "dk4error.h" #else #include #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
if pdst is NULL or szdst is 0, - DK4_E_NOT_FOUND
if the login name was not found, - DK4_E_BUFFER_TOO_SMALL
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
if pdst is NULL or szdst is 0, - DK4_E_NOT_FOUND
if the login name, the user entry or the home directory was not found, - DK4_E_MEMORY
if an internal memory allocation failed, - DK4_E_SYNTAX
if the retrieved registry entry on Windows is not a string, - DK4_E_BUFFER_TOO_SMALL
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