debian man page for optionfileload

optionFileLoad(3)						Programmer's Manual						 optionFileLoad(3)

NAME
       optionFileLoad - Load the locatable config files, in order

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

       int optionFileLoad(tOptions* pOpts, char const* pzProg);

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  pro-
       cessed.	 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.

       pOpts  program options descriptor

       pzProg 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 -lopts library.
       ao_string_tokenize(3), configFileLoad(3), optionFindNextValue(3), optionFindValue(3), optionFree(3), optionGetValue(3),	optionLoadLine(3),
       optionNextValue(3),  optionOnlyUsage(3),  optionProcess(3), optionRestore(3), optionSaveFile(3), optionSaveState(3), optionUnloadNested(3),
       optionVersion(3), pathfind(3), strequate(3), streqvcmp(3), streqvmap(3), strneqvcmp(3), strtransform(3),

								    2011-07-10							 optionFileLoad(3)