| [ < ] | [ > ] | [ << ] | [ Up ] | [ >> ] | [Top] | [Contents] | [Index] | [ ? ] |
saves the option state to memory
Usage:
optionSaveState( pOpts ); |
Where the arguments are:
Name | Type | Description | |
--- | --- | --------- | |
pOpts | | 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(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)
If it fails to allocate the memory, it will print a message to stderr and exit. Otherwise, it will always succeed.
This document was generated by Bruce Korb on September, 30 2006 using texi2html 1.76.