ParseResult Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Describes the results of parsing a command line input based on a specific parser configuration.
public ref class ParseResult
public class ParseResult
type ParseResult = class
Public Class ParseResult
- Inheritance
-
ParseResult
Properties
CommandResult |
A result indicating the command specified in the command line input. |
Directives |
Gets the directives found while parsing command line input. |
Errors |
Gets the parse errors found while parsing command line input. |
Parser |
The parser used to produce the parse result. |
RootCommandResult |
Gets the root command result. |
Tokens |
Gets the tokens identified while parsing command line input. |
UnmatchedTokens |
Gets the list of tokens used on the command line that were not matched by the parser. |
UnparsedTokens |
Gets the list of tokens used on the command line that were ignored by the parser. |
Methods
Equals(Object) |
Determines whether the specified object is equal to the current object. (Inherited from Object) |
FindResultFor(Argument) |
Gets the result, if any, for the specified argument. |
FindResultFor(Command) |
Gets the result, if any, for the specified command. |
FindResultFor(Option) |
Gets the result, if any, for the specified option. |
FindResultFor(Symbol) |
Gets the result, if any, for the specified symbol. |
GetCompletionContext() |
Gets the completion context for the parse result. |
GetCompletions(Nullable<Int32>) |
Gets completions based on a given parse result. |
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. |
GetValueForArgument<T>(Argument<T>) |
Gets the parsed or default value for the specified argument. |
GetValueForOption(Option) |
Gets the parsed or default value for the specified option. |
GetValueForOption<T>(Option<T>) |
Gets the parsed or default value for the specified option. |
MemberwiseClone() |
Creates a shallow copy of the current Object. (Inherited from Object) |
ToString() |
Returns a string that represents the current object. |
Extension Methods
Diagram(ParseResult) |
Formats a string explaining a parse result. |
HasOption(ParseResult, Option) |
Indicates whether a given option is present in the parse result. |
Invoke(ParseResult, IConsole) |
Invokes the appropriate command handler for a parsed command line input. |
InvokeAsync(ParseResult, IConsole) |
Invokes the appropriate command handler for a parsed command line input. |