diff options
Diffstat (limited to 'autoopts/optionFindValue.3')
| -rw-r--r-- | autoopts/optionFindValue.3 | 46 |
1 files changed, 46 insertions, 0 deletions
diff --git a/autoopts/optionFindValue.3 b/autoopts/optionFindValue.3 new file mode 100644 index 0000000..2c729f2 --- /dev/null +++ b/autoopts/optionFindValue.3 @@ -0,0 +1,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), |