AutoGen - The Automated Program Generator: 7.5.32.14 optionSaveState

[ < ] | [ > ] |  | [ << ] | [ Up ] | [ >> ] |  |  |  |  | [Top] | [Contents] | [Index] | [ ? ]

#### 7.5.32.14 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(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.

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 December, 31 2008 using texi2html 1.78.