IVsHierarchyRefactorNotify::OnBeforeGlobalSymbolRenamed Method (UInt32, array<UInt32>^, UInt32, array<String^>^, String^, Int32)

Visual Studio 2015

Called when a symbol is about to be renamed.

Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop.8.0 (in Microsoft.VisualStudio.Shell.Interop.8.0.dll)

Syntax

C++

int OnBeforeGlobalSymbolRenamed(
	unsigned int cItemsAffected,
	array<unsigned int>^ rgItemsAffected,
	unsigned int cRQNames,
	array<String^>^ rglpszRQName,
	String^ lpszNewName,
	int promptContinueOnFail
)

Parameters

cItemsAffected: Type: System::UInt32
The number of files affected by the rename.

rgItemsAffected: Type: array<System::UInt32>^
An array of VSITEMIDs that identifies the files that will be affected.

cRQNames: Type: System::UInt32
The number of renamed symbols. The number can be greater than one, if an overloaded symbol is renamed.

rglpszRQName: Type: array<System::String^>^
The name of the symbol before rename.

lpszNewName: Type: System::String^
The name of the symbol after the rename.

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

Return Value

Type: System::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:

C++

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);