sg_init man page

sg_init, sg_snapshot, sg_shutdown, sg_drop_privileges — initialise libstatgrab

Synopsis

#include <statgrab.h>

sg_errorsg_init (intignore_init_errors);

sg_errorsg_snapshot (void);

sg_errorsg_shutdown (void);

sg_errorsg_drop_privileges (void);

Description

sg_init() either initialises the statgrab library and sets the initialisation counter to 1, if not already 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 component is invoked, some global variables are initialised, requested mutual exclusion semaphores are initialised 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 appropriate error code from an constructor/destructor.

See Also

statgrab(3)

Website

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

Referenced By

sg_drop_privileges(3), sg_shutdown(3) and sg_snapshot(3) are aliases of sg_init(3).

2013-06-07 i-scream