summaryrefslogtreecommitdiff
path: root/autoopts/optionFindValue.3
blob: 2c729f2f668a37bfad409a709cf4ab2dc0f821e2 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
.TH optionFindValue 3 2012-08-11 "" "Programmer's Manual"
.\"  DO NOT EDIT THIS FILE   (optionFindValue.3)
.\"  
.\"  It has been AutoGen-ed  August 11, 2012 at 09:44:56 AM by AutoGen 5.16.2
.\"  From the definitions    ./funcs.def
.\"  and the template file   agman3.tpl
.SH NAME
optionFindValue - find a hierarcicaly valued option instance
.sp 1
.SH SYNOPSIS

#include <\fIyour-opts.h\fP>
.br
cc [...] -o outfile infile.c -l\fBopts\fP [...]
.sp 1
const tOptionValue* \fBoptionFindValue\fP(const tOptDesc* \fIpOptDesc\fP, char const* \fIname\fP, char const* \fIvalue\fP);
.sp 1
.SH DESCRIPTION
This routine will find an entry in a nested value option or configurable.
It will search through the list and return a matching entry.
.TP
.IR pOptDesc
an option with a nested arg type
.TP
.IR name
name of value to find
.TP
.IR value
the matching value
.sp 1
.SH RETURN VALUE
a compound value structure
.sp 1
.SH ERRORS
The returned result is NULL and errno is set:
.sp 1ize @bullet
.sp 1
\fBEINVAL\fP \- the \fBpOptValue\fP does not point to a valid
hierarchical option value.
.sp 1
\fBENOENT\fP \- no entry matched the given name.
@end itemize
.SH SEE ALSO
The \fIinfo\fP documentation for the -l\fIopts\fP library.
.br
ao_string_tokenize(3), configFileLoad(3), optionFileLoad(3), optionFindNextValue(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),