1optionGetValue(3)             Programmer's Manual            optionGetValue(3)
2
3
4

NAME

6       optionGetValue - get a specific value from a hierarcical list
7
8

SYNOPSIS

10       #include <your-opts.h>
11       cc [...] -o outfile infile.c -lopts [...]
12
13       const  tOptionValue* optionGetValue(const tOptionValue* pOptValue, char
14       const* valueName);
15
16

DESCRIPTION

18       This routine will find an entry in a nested  value  option  or  config‐
19       urable.   If  "valueName"  is  NULL,  then the first entry is returned.
20       Otherwise, the first entry with a name that exactly matches  the  argu‐
21       ment will be returned.  If there is no matching value, NULL is returned
22       and errno is set to ENOENT. If the provided option value is not a hier‐
23       archical value, NULL is also returned and errno is set to EINVAL.
24
25       pOptValue
26              a hierarchcal value
27
28       valueName
29              name of value to get
30
31

RETURN VALUE

33       a compound value structure
34
35

ERRORS

37       The returned result is NULL and errno is set:
38
39
40
41
42
43
44
45       EINVAL  -  the  pOptValue does not point to a valid hierarchical option
46       value.
47
48       ENOENT - no entry matched the given name.  @end itemize
49

SEE ALSO

51       The info documentation for the -lopts library.
52       ao_string_tokenize(3),  configFileLoad(3),  optionFileLoad(3),  option‐
53       FindNextValue(3), optionFindValue(3), optionFree(3), optionLoadLine(3),
54       optionMemberList(3), optionNextValue(3), optionOnlyUsage(3), optionPro‐
55       cess(3),   optionRestore(3),   optionSaveFile(3),   optionSaveState(3),
56       optionUnloadNested(3),  optionVersion(3),  strequate(3),  streqvcmp(3),
57       streqvmap(3), strneqvcmp(3), strtransform(3),
58
59
60
61                                  2014-06-10                 optionGetValue(3)
Impressum