IVsRefactorNotify::OnBeforeGlobalSymbolRenamed Method (IVsHierarchy^, UInt32, UInt32, array<String^>^, String^, Array^)

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(
	IVsHierarchy^ pHier,
	unsigned int itemid,
	unsigned int cRQNames,
	array<String^>^ rglpszRQName,
	String^ lpszNewName,
	[OutAttribute] Array^% prgAdditionalCheckoutVSITEMIDs
)

Parameters

pHier: Type: Microsoft.VisualStudio.Shell.Interop::IVsHierarchy^
The hierarchy of the designer-owned item associated with the file that the language service changed.

itemid: Type: System::UInt32
The VSITEMID of the designer-owned item associated with the file that the language service changed.

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

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

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

prgAdditionalCheckoutVSITEMIDs: Type: System::Array^
An array of VSITEMIDs to be checked out during the rename operation, if the IVsRefactorNotify implementer must modify additional files as a part of the refactoring operation. Implementers must return the VSITEMID of the designer-owned item, if that file is modified during the refactoring operation.

Return Value

Type: System::Int32

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

Remarks

COM Signature

From vsshell80.idl:

C++

HRESULT OnBeforeGlobalSymbolRenamed(
    [in] IVsHierarchy *pHier,
    [in] VSITEMID itemid,
    [in] ULONG cRQNames,
    [in, size_is(cRQNames)] LPCOLESTR rglpszRQName[],
    [in] LPCOLESTR lpszNewName,
    [out, retval] SAFEARRAY(VSITEMID)* prgAdditionalCheckoutVSITEMIDs);