1ggGetUserDir(3)                       GGI                      ggGetUserDir(3)
2
3
4

NAME

6       ggGetUserDir : Get user home directory
7

SYNOPSIS

9       #include <ggi/gg.h>
10
11       const char * ggGetUserDir(void);
12
13

DESCRIPTION

15       ggGetUserDir returns a path to the home directory of the user executing
16       an application, whatever it may be on a given system.  For example,  on
17       unix  systems it will be the contents of the HOME environment variable.
18       If no user home exists, a suitable temporary directory is found.
19
20       ggGetUserDir is threadsafe, but is not guaranteed to be safe to use  in
21       a  thread  that  may be cancelled during its execution.  It is also not
22       guaranteed to be safe to use in special contexts  such  as  LibGG  task
23       handlers, signal handlers and asyncronous procedure calls.
24

RETURN VALUE

26       ggGetUserDir  returns a NULL-terminated string holding the path the the
27       current user home directory.  This string may be a reference to  memory
28       belonging to OS facilities, and Bmust not* be freed or altered.
29
30
31
32libgg-1.0.x                       2005-08-26                   ggGetUserDir(3)