CompletionContext.GetWordToComplete Method

Definition

Namespace:

System.CommandLine.Completions

Assembly:

System.CommandLine.dll

Gets the text to be matched for completion, which can be used to filter a list of completions.

protected static string GetWordToComplete (System.CommandLine.Parsing.ParseResult parseResult, int? position = default);

static member GetWordToComplete : System.CommandLine.Parsing.ParseResult * Nullable<int> -> string

Protected Shared Function GetWordToComplete (parseResult As ParseResult, Optional position As Nullable(Of Integer) = Nothing) As String

Parameters

parseResult

ParseResult

A parse result.

position

Nullable<Int32>

The position within the raw input, if available, at which to provide completions.

Returns

String

A string containing the user-entered text to be matched for completions.