NAME¶

econf_getGroups - retrieve all groups from a configuration file

SYNOPSIS¶

#include <libeconf.h>

econf_err econf_getGroups(econf_file *kf, size_t *length, char ***groups);

DESCRIPTION¶

The econf_getGroups() function retrieves a list of all groups (sections) defined in the configuration file object specified by kf.

Upon successful return, length will contain the number of groups found, and groups will point to a newly allocated array of strings (group names). The memory for this array and the strings within it is allocated by the function and must be freed by the caller using econf_freeArray().

RETURN VALUE¶

If successful, ECONF_SUCCESS is returned. Otherwise, an error code is returned to indicate the error.

ERRORS¶

ECONF_ARGUMENT_IS_NULL_VALUE

ECONF_NOGROUP

ECONF_NOMEM

SEE ALSO¶

libeconf(3), econf_getKeys(3), econf_freeArray(3), econf_errString(3)