NAME

       sg_init, sg_snapshot, sg_shutdown, sg_drop_privileges - initialise libstatgrab

SYNOPSIS

       #include <statgrab.h>

       sg_error sg_init (int ignore_init_errors);

       sg_error sg_snapshot (void);

       sg_error sg_shutdown (void);

       sg_error sg_drop_privileges (void);

DESCRIPTION

       sg_init()  either  initialises  the statgrab library and sets the initialisation counter to 1, if not al‐
       ready done, or increases the initialisation counter.  If called for the first time (in  fact:  if  called
       when the initialisation counter is 0), the constructor (initialisation routine) of each registered compo‐
       nent  is  invoked,  some global variables are initialised, requested mutual exclusion semaphores are ini‐
       tialised and so on.  sg_init() is protected by the mutex named "statgrab".

       sg_snapshot() is Win32 only and will probably disappear.

       sg_shutdown() decrements the initialisation counter. If the counter reaches zero, components' destructors
       are called, mutual exclusion semaphores (exept "statgrab") are destroyed etc.  sg_shutdown() is protected
       by the mutex named "statgrab".

       sg_drop_privileges() drops elevated privileges.

RETURN VALUES

       All functions return a statgrab error code. Either SG_ERROR_NONE when everything was ok or the  appropri‐
       ate error code from an constructor/destructor.

SEE ALSO

       statgrab(3)

WEBSITE

       ⟨http://www.i-scream.org/libstatgrab/⟩

i-scream                                           2013-06-07                                         sg_init(3)