diff options
Diffstat (limited to 'autoopts/optionSaveState.3')
| -rw-r--r-- | autoopts/optionSaveState.3 | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/autoopts/optionSaveState.3 b/autoopts/optionSaveState.3 new file mode 100644 index 0000000..57567db --- /dev/null +++ b/autoopts/optionSaveState.3 @@ -0,0 +1,41 @@ +.TH optionSaveState 3 2012-08-11 "" "Programmer's Manual" +.\" DO NOT EDIT THIS FILE (optionSaveState.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 +optionSaveState - saves the option state to memory +.sp 1 +.SH SYNOPSIS + +#include <\fIyour-opts.h\fP> +.br +cc [...] -o outfile infile.c -l\fBopts\fP [...] +.sp 1 +void \fBoptionSaveState\fP(tOptions* \fIpOpts\fP); +.sp 1 +.SH DESCRIPTION +This routine will allocate enough memory to save the current option +processing state. If this routine has been called before, that memory +will be reused. You may only save one copy of the option state. This +routine may be called before optionProcess(3AO). If you do call it +before the first call to optionProcess, then you may also change the +contents of argc/argv after you call optionRestore(3AO) + +In fact, more strongly put: it is safest to only use this function +before having processed any options. In particular, the saving and +restoring of stacked string arguments and hierarchical values is +disabled. The values are not saved. +.TP +.IR pOpts +program options descriptor +.sp 1 +.SH ERRORS +If it fails to allocate the memory, +it will print a message to stderr and exit. +Otherwise, it will always succeed. +.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), optionNextValue(3), optionOnlyUsage(3), optionProcess(3), optionRestore(3), optionSaveFile(3), optionUnloadNested(3), optionVersion(3), pathfind(3), strequate(3), streqvcmp(3), streqvmap(3), strneqvcmp(3), strtransform(3), |