GetWizardOptions • IsWizardOption • ListWizardOptions • ParseWizardOption • WizardOptionToMnemonic
GetWizardOptions
GetWizardOptions() returns a list of options.
The format of the GetWizardOptions method is:
const char **GetWizardOptions(const WizardOption option)
A description of each parameter follows:
- option
- The option.
IsWizardOption
IsWizardOption() returns WizardTrue if the option begins with a - or + and the first character that follows is alphanumeric.
The format of the IsWizardOption method is:
WizardBooleanType IsWizardOption(const char *option)
A description of each parameter follows:
- option
- The option.
ListWizardOptions
ListWizardOptions() lists the contents of enumerated option type(s).
The format of the ListWizardOptions method is:
WizardBooleanType ListWizardOptions(FILE *file,const WizardOption option, ExceptionInfo *exception)
A description of each parameter follows:
- file
- list options to this file handle.
- option
- which option list to display.
- exception
- return any errors or warnings in this structure.
ParseWizardOption
ParseWizardOption() parses an option string and returns an enumerated option type(s).
The format of the ParseWizardOption method is:
ssize_t ParseWizardOption(const WizardOption option, const WizardBooleanType list,const char *options)
A description of each parameter follows:
- option
- The option.
- list
- A option other than zero permits more than one option separated by commas.
- options
- One or more options separated by commas.
WizardOptionToMnemonic
WizardOptionToMnemonic() returns an enumerated option as a mnemonic.
The format of the WizardOptionToMnemonic method is:
const char *WizardOptionToMnemonic(const WizardOption option, const ssize_t type)
A description of each parameter follows:
- option
- the option.
- type
- one or more options separated by commas.