TryGetQueryDescription Method

Try extract the query description from a query string.

Syntax

[Extension()]
public static bool TryGetQueryDescription( 
   string queryString,
   StringFormattingKind stringFormattingKind,
   out string queryDescription
)

Parameters

queryString: The query string.
stringFormattingKind: The string formatting kind of the output string.
queryDescription: The query description extracted.

Return Value

true if the query description has been extracted, else returns false.

Remarks

The query description, if any, is enclosed between the tags <Desc> and </Desc>, or <Description> and </Description>, in one or several consecutive comment line(s) in the query string.

Requirements

Target Platforms: Windows 11, 10, 8, 7 and Linux, MacOS with net8.0, net7.0 or net6.0 installed

Reference

ExtensionMethodsQuery Class
ExtensionMethodsQuery Members