7.4.28.6 optionSaveState

saves the option state to memory

Usage:

optionSaveState( pOpts );

Where the arguments are:

	Name	Type	Description
	-----	-----	-------------
	pOpts	tOptions*	program options descriptor

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(3).

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