diff options
Diffstat (limited to 'autoopts/optionGetValue.3')
| -rw-r--r-- | autoopts/optionGetValue.3 | 47 |
1 files changed, 47 insertions, 0 deletions
diff --git a/autoopts/optionGetValue.3 b/autoopts/optionGetValue.3 new file mode 100644 index 0000000..3a908b8 --- /dev/null +++ b/autoopts/optionGetValue.3 @@ -0,0 +1,47 @@ +.TH optionGetValue 3 2012-08-11 "" "Programmer's Manual" +.\" DO NOT EDIT THIS FILE (optionGetValue.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 +optionGetValue - get a specific value from a hierarcical list +.sp 1 +.SH SYNOPSIS + +#include <\fIyour-opts.h\fP> +.br +cc [...] -o outfile infile.c -l\fBopts\fP [...] +.sp 1 +const tOptionValue* \fBoptionGetValue\fP(const tOptionValue* \fIpOptValue\fP, char const* \fIvalueName\fP); +.sp 1 +.SH DESCRIPTION +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. +.TP +.IR pOptValue +a hierarchcal value +.TP +.IR valueName +name of value to get +.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), optionFindValue(3), optionFree(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), |