Edit

Share via


ArgumentResult Class

Definition

A result produced when parsing an Argument.

public ref class ArgumentResult : System::CommandLine::Parsing::SymbolResult
public class ArgumentResult : System.CommandLine.Parsing.SymbolResult
type ArgumentResult = class
    inherit SymbolResult
Public Class ArgumentResult
Inherits SymbolResult
Inheritance
ArgumentResult

Properties

Argument

The argument to which the result applies.

Children

Child symbol results in the parse tree.

(Inherited from SymbolResult)
ErrorMessage

An error message for this symbol result.

(Inherited from SymbolResult)
LocalizationResources

Localization resources used to produce messages for this symbol result.

(Inherited from SymbolResult)
Parent

The parent symbol result in the parse tree.

(Inherited from SymbolResult)
Symbol

The symbol to which the result applies.

(Inherited from SymbolResult)
Tokens

The list of tokens associated with this symbol result during parsing.

(Inherited from SymbolResult)

Methods

Equals(Object)

Determines whether the specified object is equal to the current object.

(Inherited from Object)
FindResultFor(Argument)

Finds a result for the specific argument anywhere in the parse tree, including parent and child symbol results.

(Inherited from SymbolResult)
FindResultFor(Command)

Finds a result for the specific command anywhere in the parse tree, including parent and child symbol results.

(Inherited from SymbolResult)
FindResultFor(Option)

Finds a result for the specific option anywhere in the parse tree, including parent and child symbol results.

(Inherited from SymbolResult)
GetHashCode()

Serves as the default hash function.

(Inherited from Object)
GetType()

Gets the Type of the current instance.

(Inherited from Object)
GetValueForArgument(Argument)

Gets the parsed or default value for the specified argument.

(Inherited from SymbolResult)
GetValueForArgument<T>(Argument<T>)

Gets the parsed or default value for the specified argument.

(Inherited from SymbolResult)
GetValueForOption(Option)

Gets the parsed or default value for the specified option.

(Inherited from SymbolResult)
GetValueForOption<T>(Option<T>)

Gets the parsed or default value for the specified option.

(Inherited from SymbolResult)
GetValueOrDefault()

Gets the parsed value or the default value for Argument.

GetValueOrDefault<T>()

Gets the parsed value or the default value for Argument.

MemberwiseClone()

Creates a shallow copy of the current Object.

(Inherited from Object)
OnlyTake(Int32)

Specifies the maximum number of tokens to consume for the argument. Remaining tokens are passed on and can be consumed by later arguments, or will otherwise be added to UnmatchedTokens

ToString()

Returns a string that represents the current object.

Applies to