Record TOption

Hierarchy
Methods
Properties

Unit

Declaration

type TOption = record

Description

Command-line option specification, for TParameters.Parse.

Both Short and Long option names are case-sensitive. The convention is to make Long option names using only lower-case letters, separates by dashes, like my-option-name.

Note that spaces are allowed (as Short option name, or within Long option nam), but in practice should not be used as they are a pain to pass for the users (you'd have to quote option names under most shells).

Overview

Fields

Public Short: Char;
Public Long: string;
Public Argument: TOptionArgument;

Description

Fields

Public Short: Char;

Short option name. Use #0 if none. Cannot be '-' or '=' (these would cause ambiguity when parsing options).

Public Long: string;

Long option name. Use '' if none. Cannot contain '=' (this would cause ambiguity when parsing options).

Public Argument: TOptionArgument;
 

Generated by PasDoc 0.16.0.