Class ACommandLineList

DescriptionHierarchyFieldsMethodsProperties

Unit

Declaration

type ACommandLineList = class(ACommandLineOption)

Description

This class represents an option that can be specified more than once on the command line; each time it occurs, the value specified is added to a list of values.

ACommandLineList.value will contain the most recent value assigned to this option, while ACommandLineList.Values will contain all values assigned to the option, including the most recent.

Hierarchy

Overview

Fields

Protected MyValues: AVariantList;

Methods

Public function init: boolean; override;
Public destructor destroy; override;
Public function Values: AVariantList; virtual;
Public function setValue(const newValue: Variant; const makeDirty: boolean = true): Variant; override;

Description

Fields

Protected MyValues: AVariantList;

Refers to the list of values collected for the option

Methods

Public function init: boolean; override;

Initializer

Public destructor destroy; override;

Destroy the option.

This method frees the values in ACommandLineList.Values and then calls the inherited routine.

Public function Values: AVariantList; virtual;

Retrieve a reference to the list of values collected for the option.

The most recent value collected for the option will always be at the end of the list, and can also be obtained by calling ACommandLineList.value.

The caller should NOT attempt to free the reference returned by this routine; that will be done when the option itself is freed.

Public function setValue(const newValue: Variant; const makeDirty: boolean = true): Variant; override;

Set the value of the option.

This method overrides the behavior inherited from ACommandLineOption.setValue. It adds newValue to the list of values maintained for the option, then sets Self.value to newValue.

Returns

The previous value of ACommandLineList.value.


Generated by PasDoc 0.13.0 on 2015-01-10 17:13:18