[Overview][Types][Classes][Procedures and functions][Index] Reference for unit 'CmdLine' (#Pkg)

DefineEnumOption

Defines a new enum option.

Declaration

Source position: cmdline.pas line 291

procedure DefineEnumOption(

  ShortOpt: Char;

  const LongOpt: string;

  VarPtr: PString;

  const ValidValues: string;

  const Help: UTF8String;

  const ArgName: string;

  Flags: TOptionFlags = []

);

Arguments

ShortOpt

  

Short option (If there is no short option then set it to #0)

LongOpt

  

Long option

VarPtr

  

If VarPtr is not nil then the variable pointed by VarPtr is set according to the command line.

ValidValues

  

A comma separated list of valid pascal identifiers.

Help

  

The help string associated with the option.

ArgName

  

The argument name of the option. It is used by DisplayHelp.

Description

The command line parser raises ECmdLineError exception if the value is not part of ValidValues.

See also

DisplayHelp

  

Display the help for the tool.