Class UnrecognizedCommandParsingException

The exception that is thrown when an invalid argument is given and when we can make suggestions about similar, valid commands or options.

Inheritance
System.Object
System.Exception
CommandParsingException
UnrecognizedCommandParsingException
Implements
System.Runtime.Serialization.ISerializable
Inherited Members
System.Exception.GetBaseException()
System.Exception.GetObjectData(System.Runtime.Serialization.SerializationInfo, System.Runtime.Serialization.StreamingContext)
System.Exception.GetType()
System.Exception.ToString()
System.Exception.Data
System.Exception.HelpLink
System.Exception.HResult
System.Exception.InnerException
System.Exception.Message
System.Exception.Source
System.Exception.StackTrace
System.Exception.TargetSite
System.Exception.SerializeObjectState
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: McMaster.Extensions.CommandLineUtils
Assembly: McMaster.Extensions.CommandLineUtils.dll
Syntax
public class UnrecognizedCommandParsingException : CommandParsingException, ISerializable

Constructors

| Improve this Doc View Source

UnrecognizedCommandParsingException(CommandLineApplication, IEnumerable<String>, String)

Initializes an instance of UnrecognizedCommandParsingException.

Declaration
public UnrecognizedCommandParsingException(CommandLineApplication command, IEnumerable<string> nearestMatches, string message)
Parameters
Type Name Description
CommandLineApplication command
System.Collections.Generic.IEnumerable<System.String> nearestMatches

The options or commands that

System.String message

Properties

| Improve this Doc View Source

NearestMatches

A collection of strings representing suggestions about similar and valid commands or options for the invalid argument that caused this UnrecognizedCommandParsingException.

Declaration
public IEnumerable<string> NearestMatches { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<System.String>

This property get/set the suggestions for an invalid argument.
Remarks

This property always be empty MakeSuggestionsInErrorMessage is false.

Implements

System.Runtime.Serialization.ISerializable