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

DefinePathOption

Defines a new path option.

Declaration

Source position: cmdline.pas line 329

procedure DefinePathOption(

  ShortOpt: Char;

  const LongOpt: string;

  VarPtr: PString;

  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.

Help

  

The help string associated with the option.

ArgName

  

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

Description

The parser applies some changes to the value :

See also

DisplayHelp

  

Display the help for the tool.