Document.GetSyntaxRootAsync(CancellationToken) Method

Definition

Gets the root node of the syntax tree asynchronously.

C#
public System.Threading.Tasks.Task<Microsoft.CodeAnalysis.SyntaxNode> GetSyntaxRootAsync(System.Threading.CancellationToken cancellationToken = default);
C#
public System.Threading.Tasks.Task<Microsoft.CodeAnalysis.SyntaxNode?> GetSyntaxRootAsync(System.Threading.CancellationToken cancellationToken = default);

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

Product Versions
Roslyn 4.2.0, 4.3.0, 4.4.0, 4.5.0, 4.6.0, 4.7.0, 4.8.0, 4.9.2, 3.0.0, 3.1.0, 3.2.0, 3.2.1, 3.3.1, 3.4.0, 3.5.0, 3.6.0, 3.7.0, 3.8.0, 3.9.0, 3.10.0, 3.11.0, 4.0.1, 4.1.0, 4.12.2, 4.13.0