ArgumentResult.OnlyTake(Int32) Method

Definition

Namespace:

System.CommandLine.Parsing

Assembly:

System.CommandLine.dll

Package:

System.CommandLine v2.0.0-beta4.22272.1

Source:

ArgumentResult.cs

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

public:
 void OnlyTake(int numberOfTokens);

public void OnlyTake(int numberOfTokens);

member this.OnlyTake : int -> unit

Public Sub OnlyTake (numberOfTokens As Integer)

Parameters

numberOfTokens

Int32

The number of tokens to take. The rest are passed on.

Exceptions

ArgumentOutOfRangeException

numberOfTokens - Value must be at least 1.

InvalidOperationException

Thrown if this method is called more than once.