[Overview][Constants][Types][Procedures and functions][Variables] Reference for unit 'getopts' (#rtl)

GetLongOpts

Return next long option.

Declaration

Source position: getopts.pp line 46

function GetLongOpts(

  ShortOpts: String;

  LongOpts: POption;

  var Longind: LongInt

):Char;

Description

Returns the next option found on the command-line, taking into account long options as well. If no more options are found, returns EndOfOptions. If the option requires an argument, it is returned in the OptArgvariable.

ShortOptionsis a string containing all possible one-letter options. (see Getoptfor its description and use) LongOptsis a pointer to the first element of an array of Optionrecords, the last of which needs a name of zero length.

The function tries to match the names even partially (i.e. --appwill match e.g. the appendoption), but will report an error in case of ambiguity. If the option needs an argument, set Has_argto Required_argument, if the option optionally has an argument, set Has_argto Optional_argument. If the option needs no argument, set Has_argto zero.

Required arguments can be specified in two ways :

  1. Pasted to the option : --option=value
  2. As a separate argument : --option value

Optional arguments can only be specified through the first method.

Errors

see Getopt.

See also

Getopt

  

Get next short option.