IVsHierarchyRefactorNotify.OnBeforeGlobalSymbolRenamed Method

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Called when a symbol is about to be renamed.

public:
 int OnBeforeGlobalSymbolRenamed(System::UInt32 cItemsAffected, cli::array <System::UInt32> ^ rgItemsAffected, System::UInt32 cRQNames, cli::array <System::String ^> ^ rglpszRQName, System::String ^ lpszNewName, int promptContinueOnFail);

public:
 int OnBeforeGlobalSymbolRenamed(unsigned int cItemsAffected, Platform::Array <unsigned int> ^ rgItemsAffected, unsigned int cRQNames, Platform::Array <Platform::String ^> ^ rglpszRQName, Platform::String ^ lpszNewName, int promptContinueOnFail);

int OnBeforeGlobalSymbolRenamed(unsigned int cItemsAffected, std::Array <unsigned int> const & rgItemsAffected, unsigned int cRQNames, std::Array <std::wstring const &> const & rglpszRQName, std::wstring const & lpszNewName, int promptContinueOnFail);

public int OnBeforeGlobalSymbolRenamed (uint cItemsAffected, uint[] rgItemsAffected, uint cRQNames, string[] rglpszRQName, string lpszNewName, int promptContinueOnFail);

abstract member OnBeforeGlobalSymbolRenamed : uint32 * uint32[] * uint32 * string[] * string * int -> int

Public Function OnBeforeGlobalSymbolRenamed (cItemsAffected As UInteger, rgItemsAffected As UInteger(), cRQNames As UInteger, rglpszRQName As String(), lpszNewName As String, promptContinueOnFail As Integer) As Integer

Parameters

cItemsAffected

UInt32

The number of files affected by the rename.

rgItemsAffected

UInt32[]

An array of VSITEMIDs that identifies the files that will be affected.

cRQNames

UInt32

The number of renamed symbols. The number can be greater than one, if an overloaded symbol is renamed.

rglpszRQName

String[]

The name of the symbol before rename.

lpszNewName

String

The name of the symbol after the rename.

promptContinueOnFail

Int32

true to prompt the user to continue the rename operation if one or more IVsRefactorNotify implementers fails; otherwise, false.

Returns

Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

To stop the rename operation, the HRESULT must contain one of the following error codes:

E_ABORT

OLE_E_PROMPTSAVECANCELLED

OLECMDERR_E_CANCELED

HR_E_CSHARP_USER_CANCEL

A symbol with the same name may have more than one occurrence, if the language allows overloading operations, such as method overloading:

void SomeMethod() {}  
void SomeMethod(int i) {}  

COM Signature

From vsshell80.idl:

HRESULT OnBeforeGlobalSymbolRenamed(  
    [in] ULONG cItemsAffected,                                 
    [in, size_is(cItemsAffected)] VSITEMID rgItemsAffected[],  
    [in] ULONG cRQNames,                                       
    [in, size_is(cRQNames)] LPCOLESTR rglpszRQName[],          
    [in] LPCOLESTR lpszNewName,                                
    [in] BOOL promptContinueOnFail);