Renamer.RenameSymbolAsync Method

Definition

Namespace:

Microsoft.CodeAnalysis.Rename

Assembly:

Microsoft.CodeAnalysis.Workspaces.dll

Package:

Microsoft.CodeAnalysis.Workspaces.Common v4.13.0

Overloads

RenameSymbolAsync(Solution, ISymbol, SymbolRenameOptions, String, CancellationToken)
RenameSymbolAsync(Solution, ISymbol, String, OptionSet, CancellationToken)	Obsolete.

RenameSymbolAsync(Solution, ISymbol, SymbolRenameOptions, String, CancellationToken)

Source:

Renamer.cs

public static System.Threading.Tasks.Task<Microsoft.CodeAnalysis.Solution> RenameSymbolAsync(Microsoft.CodeAnalysis.Solution solution, Microsoft.CodeAnalysis.ISymbol symbol, Microsoft.CodeAnalysis.Rename.SymbolRenameOptions options, string newName, System.Threading.CancellationToken cancellationToken = default);

static member RenameSymbolAsync : Microsoft.CodeAnalysis.Solution * Microsoft.CodeAnalysis.ISymbol * Microsoft.CodeAnalysis.Rename.SymbolRenameOptions * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.CodeAnalysis.Solution>

Public Shared Function RenameSymbolAsync (solution As Solution, symbol As ISymbol, options As SymbolRenameOptions, newName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Solution)

Parameters

solution

Solution

symbol

ISymbol

options

SymbolRenameOptions

newName

String

cancellationToken

CancellationToken

Returns

Task<Solution>

RenameSymbolAsync(Solution, ISymbol, String, OptionSet, CancellationToken)

Source:

Renamer.cs

Caution

Use overload taking RenameOptions

[System.Obsolete("Use overload taking RenameOptions")]
public static System.Threading.Tasks.Task<Microsoft.CodeAnalysis.Solution> RenameSymbolAsync(Microsoft.CodeAnalysis.Solution solution, Microsoft.CodeAnalysis.ISymbol symbol, string newName, Microsoft.CodeAnalysis.Options.OptionSet? optionSet, System.Threading.CancellationToken cancellationToken = default);

[<System.Obsolete("Use overload taking RenameOptions")>]
static member RenameSymbolAsync : Microsoft.CodeAnalysis.Solution * Microsoft.CodeAnalysis.ISymbol * string * Microsoft.CodeAnalysis.Options.OptionSet * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.CodeAnalysis.Solution>

Public Shared Function RenameSymbolAsync (solution As Solution, symbol As ISymbol, newName As String, optionSet As OptionSet, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Solution)

Parameters

solution

Solution

symbol

ISymbol

newName

String

optionSet

OptionSet

cancellationToken

CancellationToken

Returns

Task<Solution>

Attributes

ObsoleteAttribute