/*
	WARNING: This file was generated by dkct.
	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
*/

/*
Copyright (C) 2015-2017, Dirk Krause

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice,
  this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above opyright notice,
  this list of conditions and the following disclaimer in the documentation
  and/or other materials provided with the distribution.
* Neither the name of the author nor the names of contributors may be used
  to endorse or promote products derived from this software without specific
  prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS ``AS IS''
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED.
IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

#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
#include "dk4conf.h"
#endif

#ifndef DK4TYPES_H_INCLUDED
#include "dk4types.h"
#endif

#ifndef DK4ERROR_H_INCLUDED
#include "dk4error.h"
#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