Document.GetSyntaxRootAsync(CancellationToken) Method

Definition

Gets the root node of the syntax tree asynchronously.

public System.Threading.Tasks.Task<Microsoft.CodeAnalysis.SyntaxNode> GetSyntaxRootAsync (System.Threading.CancellationToken cancellationToken = default);
public System.Threading.Tasks.Task<Microsoft.CodeAnalysis.SyntaxNode?> GetSyntaxRootAsync (System.Threading.CancellationToken cancellationToken = default);
member this.GetSyntaxRootAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.CodeAnalysis.SyntaxNode>
Public Function GetSyntaxRootAsync (Optional cancellationToken As CancellationToken = Nothing) As Task(Of SyntaxNode)

Parameters

cancellationToken
CancellationToken

Returns

The returned SyntaxNode will be null if SupportsSyntaxTree returns false. This function will return the same value if called multiple times.

Applies to