Renamer.RenameDocumentActionSet.UpdateSolutionAsync Method

Definition

Namespace:

Microsoft.CodeAnalysis.Rename

Assembly:

Microsoft.CodeAnalysis.Workspaces.dll

Package:

Microsoft.CodeAnalysis.Workspaces.Common v4.7.0

Overloads

UpdateSolutionAsync(Solution, CancellationToken)	Same as calling UpdateSolutionAsync(Solution, ImmutableArray<Renamer.RenameDocumentAction>, CancellationToken) with ApplicableActions as the argument
UpdateSolutionAsync(Solution, ImmutableArray<Renamer.RenameDocumentAction>, CancellationToken)	Applies each Renamer.RenameDocumentAction in order and returns the final solution. All actions must be contained in ApplicableActions

UpdateSolutionAsync(Solution, CancellationToken)

Source:

Renamer.RenameDocumentActionSet.cs

Same as calling UpdateSolutionAsync(Solution, ImmutableArray<Renamer.RenameDocumentAction>, CancellationToken) with ApplicableActions as the argument

public System.Threading.Tasks.Task<Microsoft.CodeAnalysis.Solution> UpdateSolutionAsync (Microsoft.CodeAnalysis.Solution solution, System.Threading.CancellationToken cancellationToken);

member this.UpdateSolutionAsync : Microsoft.CodeAnalysis.Solution * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.CodeAnalysis.Solution>

Public Function UpdateSolutionAsync (solution As Solution, cancellationToken As CancellationToken) As Task(Of Solution)

Parameters

solution

Solution

cancellationToken

CancellationToken

Returns

Task<Solution>

UpdateSolutionAsync(Solution, ImmutableArray<Renamer.RenameDocumentAction>, CancellationToken)

Source:

Renamer.RenameDocumentActionSet.cs

Applies each Renamer.RenameDocumentAction in order and returns the final solution. All actions must be contained in ApplicableActions

public System.Threading.Tasks.Task<Microsoft.CodeAnalysis.Solution> UpdateSolutionAsync (Microsoft.CodeAnalysis.Solution solution, System.Collections.Immutable.ImmutableArray<Microsoft.CodeAnalysis.Rename.Renamer.RenameDocumentAction> actions, System.Threading.CancellationToken cancellationToken);

member this.UpdateSolutionAsync : Microsoft.CodeAnalysis.Solution * System.Collections.Immutable.ImmutableArray<Microsoft.CodeAnalysis.Rename.Renamer.RenameDocumentAction> * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.CodeAnalysis.Solution>

Public Function UpdateSolutionAsync (solution As Solution, actions As ImmutableArray(Of Renamer.RenameDocumentAction), cancellationToken As CancellationToken) As Task(Of Solution)

Parameters

solution

Solution

actions

ImmutableArray<Renamer.RenameDocumentAction>

cancellationToken

CancellationToken

Returns

Task<Solution>

Remarks

An empty action set is still allowed and will return a modified solution that will update the document properties as appropriate. This means we can still support when ApplicableActions is empty. It's desirable that consumers can call a rename API to produce a Renamer.RenameDocumentActionSet and immediately call UpdateSolutionAsync(Solution, ImmutableArray<Renamer.RenameDocumentAction>, CancellationToken) without having to inspect the returned ApplicableActions.