OpenTAP 9.27
API Reference
Public Member Functions | Properties | List of all members
OpenTap.Cli.UnnamedCommandLineArgument Class Reference

Used on properties of a ICliAction to define an unnamed arguments on the CLI. These can be ordered to handle cases where some values are required and others can occur multiple times. The property type will indicate how many will be consumed. The type can be either string or string[]. In case of string[] all the remaining arguments will be assigned to this property. More...

Inherits Attribute.

Public Member Functions

 UnnamedCommandLineArgument (string name)
 Constructor. More...
 

Properties

int Order [getset]
 Order or the arguments. The lowest value comes first.
 
string Name [get]
 The name of the property. This will be shown in the CLI usage output.
 
bool Required [getset]
 Indicates whether this argument is required or optional. If it's a string[] and required then this indicates that it needs at least one value.
 
string Description [getset]
 Human readable description of the argument.
 

Detailed Description

Used on properties of a ICliAction to define an unnamed arguments on the CLI. These can be ordered to handle cases where some values are required and others can occur multiple times. The property type will indicate how many will be consumed. The type can be either string or string[]. In case of string[] all the remaining arguments will be assigned to this property.

Constructor & Destructor Documentation

◆ UnnamedCommandLineArgument()

OpenTap.Cli.UnnamedCommandLineArgument.UnnamedCommandLineArgument ( string  name)
inline

Constructor.

Parameters
name

OpenTAP 9.27 API built Wed Nov 27 2024 13:14:46