summaryrefslogtreecommitdiff
path: root/autoopts/optionNextValue.3
blob: 7b332a19530dbc2343634e45af60bc07d9156607 (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
47
.TH optionNextValue 3 2012-08-11 "" "Programmer's Manual"
.\"  DO NOT EDIT THIS FILE   (optionNextValue.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
optionNextValue - get the next value from a hierarchical list
.sp 1
.SH SYNOPSIS

#include <\fIyour-opts.h\fP>
.br
cc [...] -o outfile infile.c -l\fBopts\fP [...]
.sp 1
const tOptionValue* \fBoptionNextValue\fP(const tOptionValue* \fIpOptValue\fP, const tOptionValue* \fIpOldValue\fP);
.sp 1
.SH DESCRIPTION
This routine will return the next entry after the entry passed in.  At the
end of the list, NULL will be returned.  If the entry is not found on the
list, NULL will be returned and "\fBerrno\fP" will be set to EINVAL.
The "\fBpOldValue\fP" must have been gotten from a prior call to this
routine or to "\fBopitonGetValue()\fP".
.TP
.IR pOptValue
a hierarchcal list value
.TP
.IR pOldValue
a value from this list
.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 or \fBpOldValue\fP does not point to a
member of that option value.
.sp 1
\fBENOENT\fP \- the supplied \fBpOldValue\fP pointed to the last entry.
@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), optionFindValue(3), optionFree(3), optionGetValue(3), optionLoadLine(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),