SymbolResult.GetRequiredValue Method
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.
Overloads
| GetRequiredValue<T>(Argument<T>) |
Gets the parsed or default value for the specified required argument or throws. |
| GetRequiredValue<T>(Option<T>) |
Gets the parsed or default value for the specified required option or throws. |
| GetRequiredValue<T>(String) |
Gets the value for a symbol having the specified name anywhere in the parse tree. |
GetRequiredValue<T>(Argument<T>)
- Source:
- SymbolResult.cs
Gets the parsed or default value for the specified required argument or throws.
public:
generic <typename T>
T GetRequiredValue(System::CommandLine::Argument<T> ^ argument);
public T GetRequiredValue<T>(System.CommandLine.Argument<T> argument);
member this.GetRequiredValue : System.CommandLine.Argument<'T> -> 'T
Public Function GetRequiredValue(Of T) (argument As Argument(Of T)) As T
Type Parameters
- T
Parameters
- argument
- Argument<T>
The argument for which to get a value.
Returns
The parsed value or a configured default.
Applies to
GetRequiredValue<T>(Option<T>)
- Source:
- SymbolResult.cs
Gets the parsed or default value for the specified required option or throws.
public:
generic <typename T>
T GetRequiredValue(System::CommandLine::Option<T> ^ option);
public T GetRequiredValue<T>(System.CommandLine.Option<T> option);
member this.GetRequiredValue : System.CommandLine.Option<'T> -> 'T
Public Function GetRequiredValue(Of T) (option As Option(Of T)) As T
Type Parameters
- T
Parameters
- option
- Option<T>
The option for which to get a value.
Returns
The parsed value or a configured default.
Applies to
GetRequiredValue<T>(String)
- Source:
- SymbolResult.cs
Gets the value for a symbol having the specified name anywhere in the parse tree.
public:
generic <typename T>
T GetRequiredValue(System::String ^ name);
public T GetRequiredValue<T>(string name);
member this.GetRequiredValue : string -> 'T
Public Function GetRequiredValue(Of T) (name As String) As T
Type Parameters
- T
Parameters
- name
- String
The name of the symbol for which to find a result.
Returns
An argument result if the argument was matched by the parser or has a default value; otherwise, null.