.TH optionFileLoad 3 2016-08-29 "" "Programmer's Manual"

.\"  DO NOT EDIT THIS FILE   (optionFileLoad.3)

.\"

.\"  It has been AutoGen-ed

.\"  From the definitions    ./funcs.def

.\"  and the template file   agman3.tpl

.SH NAME

optionFileLoad - Load the locatable config files, in order

.sp 1

.SH SYNOPSIS

#include <\fIyour-opts.h\fP>

.br

cc [...] -o outfile infile.c -l\fBopts\fP [...]

.sp 1

int \fBoptionFileLoad\fP(tOptions * \fIopts\fP, char const * \fIprog\fP);

.sp 1

.SH 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 \fBfirst\fP 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.

.TP

.IR opts

program options descriptor

.TP

.IR prog

program name

.sp 1

.SH RETURN VALUE

0 \-> SUCCESS, \-1 \-> FAILURE

.sp 1

.SH ERRORS

Returns the value, "-1" if the program options descriptor

is out of date or indecipherable.  Otherwise, the value "0" will

always be returned.

.SH SEE ALSO

The \fIinfo\fP documentation for the -l\fIopts\fP library.

.br

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),