NAME¶
optionFileLoad - Load the locatable config files, in order
SYNOPSIS¶
#include <
your-opts.h>
cc [...] -o outfile infile.c -l
opts [...]
int
optionFileLoad(tOptions*
opts, char const*
prog);
DESCRIPTION¶
This function looks in all the specified directories for a configuration file
("rc" file or "ini" file) and processes any found twice.
The first time through, they are processed in reverse order (last file first).
At that time, only "immediate action" configurables are processed.
For example, if the last named file specifies not processing any more
configuration files, then no more configuration files will be processed. Such
an option in the
first named directory will have no effect.
Once the immediate action configurables have been handled, then the directories
are handled in normal, forward order. In that way, later config files can
override the settings of earlier config files.
See the AutoOpts documentation for a thorough discussion of the config file
format.
Configuration files not found or not decipherable are simply ignored.
- opts
- program options descriptor
- prog
- program name
RETURN VALUE¶
0 -> SUCCESS, -1 -> FAILURE
ERRORS¶
Returns the value, "-1" if the program options descriptor is out of
date or indecipherable. Otherwise, the value "0" will always be
returned.
SEE ALSO¶
The
info documentation for the -l
opts library.
ao_string_tokenize(3),
configFileLoad(3),
optionFindNextValue(3),
optionFindValue(3),
optionFree(3),
optionGetValue(3),
optionLoadLine(3),
optionMemberList(3),
optionNextValue(3),
optionOnlyUsage(3),
optionPrintVersion(3),
optionPrintVersionAndReturn(3),
optionProcess(3),
optionRestore(3),
optionSaveFile(3),
optionSaveState(3),
optionUnloadNested(3),
optionVersion(3),
strequate(3),
streqvcmp(3),
streqvmap(3),
strneqvcmp(3),
strtransform(3),