summaryrefslogtreecommitdiff
path: root/autoopts/optionFree.3
blob: a8ea0cb71205ab32c465476fa4234be91e0482b9 (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
.TH optionFree 3 2012-08-11 "" "Programmer's Manual"
.\"  DO NOT EDIT THIS FILE   (optionFree.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
optionFree - free allocated option processing memory
.sp 1
.SH SYNOPSIS

#include <\fIyour-opts.h\fP>
.br
cc [...] -o outfile infile.c -l\fBopts\fP [...]
.sp 1
void \fBoptionFree\fP(tOptions* \fIpOpts\fP);
.sp 1
.SH DESCRIPTION
AutoOpts sometimes allocates memory and puts pointers to it in the
option state structures.  This routine deallocates all such memory.
.TP
.IR pOpts
program options descriptor
.sp 1
.SH ERRORS
As long as memory has not been corrupted,
this routine is always successful.
.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), 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),