IVsHierarchyRefactorNotify.OnGlobalSymbolRenamed Method

  • Article

Called after a symbol is renamed.

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

Syntax

'Declaration
Function OnGlobalSymbolRenamed ( _
    cItemsAffected As UInteger, _
    rgItemsAffected As UInteger(), _
    cRQNames As UInteger, _
    rglpszRQName As String(), _
    lpszNewName As String _
) As Integer

int OnGlobalSymbolRenamed(
    uint cItemsAffected,
    uint[] rgItemsAffected,
    uint cRQNames,
    string[] rglpszRQName,
    string lpszNewName
)

int OnGlobalSymbolRenamed(
    [InAttribute] unsigned int cItemsAffected, 
    [InAttribute] array<unsigned int>^ rgItemsAffected, 
    [InAttribute] unsigned int cRQNames, 
    [InAttribute] array<String^>^ rglpszRQName, 
    [InAttribute] String^ lpszNewName
)

abstract OnGlobalSymbolRenamed : 
        cItemsAffected:uint32 * 
        rgItemsAffected:uint32[] * 
        cRQNames:uint32 * 
        rglpszRQName:string[] * 
        lpszNewName:string -> int

function OnGlobalSymbolRenamed(
    cItemsAffected : uint, 
    rgItemsAffected : uint[], 
    cRQNames : uint, 
    rglpszRQName : String[], 
    lpszNewName : String
) : int

Parameters

  • cItemsAffected
    Type: UInt32

    The number of files affected by the rename.

  • rgItemsAffected
    Type: array<UInt32[]

    An array of VSITEMIDs that identifies the affected files.

  • cRQNames
    Type: UInt32

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

  • rglpszRQName
    Type: array<String[]

    The name of the symbol before rename.

  • lpszNewName
    Type: String

    The name of the symbol after the rename.

Return Value

Type: 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 OnGlobalSymbolRenamed(
    [in] ULONG cItemsAffected,                               
    [in, size_is(cItemsAffected)] VSITEMID rgItemsAffected[],
    [in] ULONG cRQNames,                                     
    [in, size_is(cRQNames)] LPCOLESTR rglpszRQName[],        
    [in] LPCOLESTR lpszNewName);

.NET Framework Security

See Also

Reference

IVsHierarchyRefactorNotify Interface

Microsoft.VisualStudio.Shell.Interop Namespace