[ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
get a specific value from a hierarcical list
Usage:
const tOptionValue * res = optionGetValue( pOptValue, valueName ); |
Where the arguments are:
Name | Type | Description | |
—– | —– | ————- | |
pOptValue | const tOptionValue * | a hierarchcal value | |
valueName | char const * | name of value to get | |
returns | const tOptionValue * | a compound value structure |
This routine will find an entry in a nested value option or configurable. If "valueName" is NULL, then the first entry is returned. Otherwise, the first entry with a name that exactly matches the argument will be returned. If there is no matching value, NULL is returned and errno is set to ENOENT. If the provided option value is not a hierarchical value, NULL is also returned and errno is set to EINVAL.
The returned result is NULL and errno is set:
EINVAL
- the pOptValue
does not point to a valid
hierarchical option value.
ENOENT
- no entry matched the given name.
This document was generated by Bruce Korb on August 21, 2015 using texi2html 1.82.