| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
parse a configuration file
Usage:
const tOptionValue* res = configFileLoad( pzFile ); |
Where the arguments are:
Name | Type | Description | |
--- | --- | --------- | |
pzFile | | the file to load | |
returns | const tOptionValue* | An allocated, compound value structure |
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().
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 empty.
EINVAL - the file contents are invalid - not properly formed.
ENOMEM - not enough memory to allocate the needed structures.
This document was generated by Bruce Korb on September, 30 2006 using texi2html 1.76.