AutoGen - The Automated Program Generator: 7.5.32.8 optionLoadLine

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

#### 7.5.32.8 optionLoadLine

process a string for an option name and value

Usage:

    optionLoadLine( pOpts, pzLine );

Where the arguments are:

| Name | Type | Description
| —– | —– | ————-
| pOpts | `tOptions*` | program options descriptor
| pzLine | `char const*` | NUL-terminated text

This is a client program callable routine for setting options from, for example, the contents of a file that they read in. Only one option may appear in the text. It will be treated as a normal (non-preset) option.

When passed a pointer to the option struct and a string, it will find the option named by the first token on the string and set the option argument to the remainder of the string. The caller must NUL terminate the string. Any embedded new lines will be included in the option argument. If the input looks like one or more quoted strings, then the input will be "cooked". The "cooking" is identical to the string formation used in AutoGen definition files (see section Basic Expression), except that you may not use backquotes.

Invalid options are silently ignored. Invalid option arguments will cause a warning to print, but the function should return.

This document was generated by Bruce Korb on May, 24 2008 using texi2html 1.78.