<!DOCTYPE File PUBLIC "-//Liam Quin//DTD C API Documentation v1.1//EN" "doc.dtd"><File>
<Entry dir="liblqutil">
<Function File="../../src/liblqutil/homedir.c">
<Name>LQU_GetLoginDirectory</Name>
<Class>Utilities/System
<Purpose>
Determines the home directory of the current user.
It returns the value of the environment variable $HOME if it is set.
If this isn't set, or is empty, or does not point to a directory,
the password file (or Yellow pages) is consulted instead.
<Returns>
The directory name in a malloc's string; it is the caller's
responsibility to free this string if it should no longer be needed.
If the home directory cannot be determined, a NULL pointer is
returned; this might happen if the user's entry in /etc/passwd was
removed while the program was running, or if the Yellow Pages (NIS)
service became unavailable.
</Function>
<Decl>
API char *
LQU_GetLoginDirectory()
</Decl>
</Entry>
