Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
optionSaveState(3)	      Programmer's Manual	    optionSaveState(3)

NAME
       optionSaveState - saves the option state	to memory

SYNOPSIS
       #include	<your-opts.h>
       cc [...]	-o outfile infile.c -lopts [...]

       void optionSaveState(tOptions * pOpts);

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 be-
       fore the	first call to optionProcess, then you may also change the con-
       tents of	argc/argv after	you call optionRestore(3AO)

       In fact,	more strongly put: it is safest	to only	use this function  be-
       fore  having  processed	any  options.	In  particular,	the saving and
       restoring of stacked string arguments and hierarchical values  is  dis-
       abled.  The values are not saved.

       pOpts  program options descriptor

ERRORS
       If  it  fails to	allocate the memory, it	will print a message to	stderr
       and exit.  Otherwise, it	will always succeed.

SEE ALSO
       The info	documentation for the -lopts library.
       ao_string_tokenize(3),  configFileLoad(3),  optionFileLoad(3),  option-
       FindNextValue(3), optionFindValue(3), optionFree(3), optionGetValue(3),
       optionLoadLine(3), optionMemberList(3),	optionNextValue(3),  optionOn-
       lyUsage(3),  optionPrintVersion(3), optionPrintVersionAndReturn(3), op-
       tionProcess(3),	optionRestore(3),   optionSaveFile(3),	 optionUnload-
       Nested(3),  optionVersion(3), strequate(3), streqvcmp(3), streqvmap(3),
       strneqvcmp(3), strtransform(3),

				  2020-08-27		    optionSaveState(3)

NAME | SYNOPSIS | DESCRIPTION | ERRORS | SEE ALSO

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=optionSaveState&sektion=3&manpath=FreeBSD+12.1-RELEASE+and+Ports>

home | help