www.LinuxHowtos.org

configFileLoad

Section: Programmer's Manual (3)
Updated: 2016-10-27
Index Return to Main Contents

NAME

configFileLoad - parse a configuration file

SYNOPSIS

#include <your-opts.h>
cc [...] -o outfile infile.c -lopts [...]

const tOptionValue * configFileLoad(char const * fname);

DESCRIPTION

This routine will load a named configuration file and parse the text as a hierarchically valued option. The option descriptor created from an option definition file is not used via this interface. The returned value is "named" with the input file name and is of type "OPARG_TYPE_HIERARCHY". It may be used in calls to optionGetValue(), optionNextValue() and optionUnloadNested().

fname: the file to load

RETURN VALUE

An allocated, compound value structure

ERRORS

If the file cannot be loaded or processed, NULL is returned and errno is set. It may be set by a call to either open(2) mmap(2) or other file system calls, or it may be:

ENOENT - the file was not found.

ENOMSG - the file was empty.

EINVAL - the file contents are invalid -- not properly formed.

ENOMEM - not enough memory to allocate the needed structures. @end itemize