Interface IArgument

Fields

Unit

Command.Interfaces

Declaration

type IArgument = interface(IInterface)

Description

Interface representing an argument that can be registered in CommandBuilder for later use by the user.

Attributes

GUID['{930DA68E-6B31-4A05-A20E-C0056BFDE1AA}']

Hierarchy

IInterface
IArgument

Overview

Methods

	`function GetDescription: string;`
	`procedure SetDescription(const AValue: string);`
	`function GetConstraint: TArgumentConstraint;`
	`procedure SetConstraint(const AValue: TArgumentConstraint);`
	`function GetValue: string;`
	`procedure SetValue(const AValue: string);`

Properties

	`property Description: string read GetDescription write SetDescription;`
	`property Constraint: TArgumentConstraint read GetConstraint write SetConstraint;`
	`property Value: string read GetValue write SetValue;`

Description

Methods

	`function GetDescription: string;`

	`procedure SetDescription(const AValue: string);`

	`function GetConstraint: TArgumentConstraint;`

	`procedure SetConstraint(const AValue: TArgumentConstraint);`

	`function GetValue: string;`
returns the value of argument provided via parameter, this value should assigned after parse

	`procedure SetValue(const AValue: string);`

Properties

	`property Description: string read GetDescription write SetDescription;`
Description of the argument that best describes its purpose. It can be displayed to the user when he requests help information for the application.

	`property Constraint: TArgumentConstraint read GetConstraint write SetConstraint;`
Argument constraints that will be validated against the arguments provided by the user in order to guarantee that the command is being used correctly.

	`property Value: string read GetValue write SetValue;`
Returns the value of an argument after parsing the parameters informed via the command line. If a given command line parameter has not been classified as a command, it will be assigned to an argument in the order of configuration.

Generated by PasDoc 0.16.0.