Back

NAME

conf_get_root - top-level pseudo directive

LIBRARY

Configuration parser (libconfetti, -lconfetti)

SYNOPSIS

#include <confetti.h>

const conf_directive *conf_get_root(conf_unit *unit);

DESCRIPTION

The conf_get_root() function returns a pseudo directive representing the top-level of the Confetti configuration unit. The pointer returned remains valid until unit is released with conf_free(3).

The pseudo directive never has arguments. It is intended to be used with conf_get_directive(3) and conf_get_directive_count(3) for iterating the top-level directives of the Confetti configuration unit.

RETURN VALUE

The conf_get_root() function returns a pseudo directive representing the top-level of the Confetti configuration unit or NULL if unit is NULL.

SEE ALSO

conf_get_directive(3), conf_get_directive_count(3)

LICENSING

Confetti is Open Source software distributed under the MIT License. Please see the LICENSE file included with the Confetti distribution for details.