IVsRefactorNotify.OnGlobalSymbolRenamed Method

Article
10/26/2012

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 ( _
    pHier As IVsHierarchy, _
    itemid As UInteger, _
    cRQNames As UInteger, _
    rglpszRQName As String(), _
    lpszNewName As String _
) As Integer

'Usage
Dim instance As IVsRefactorNotify 
Dim pHier As IVsHierarchy 
Dim itemid As UInteger 
Dim cRQNames As UInteger 
Dim rglpszRQName As String()
Dim lpszNewName As String 
Dim returnValue As Integer 

returnValue = instance.OnGlobalSymbolRenamed(pHier, _
    itemid, cRQNames, rglpszRQName, lpszNewName)

int OnGlobalSymbolRenamed(
    IVsHierarchy pHier,
    uint itemid,
    uint cRQNames,
    string[] rglpszRQName,
    string lpszNewName
)

int OnGlobalSymbolRenamed(
    [InAttribute] IVsHierarchy^ pHier, 
    [InAttribute] unsigned int itemid, 
    [InAttribute] unsigned int cRQNames, 
    [InAttribute] array<String^>^ rglpszRQName, 
    [InAttribute] String^ lpszNewName
)

function OnGlobalSymbolRenamed(
    pHier : IVsHierarchy, 
    itemid : uint, 
    cRQNames : uint, 
    rglpszRQName : String[], 
    lpszNewName : String
) : int

Parameters

pHier
Type: Microsoft.VisualStudio.Shell.Interop.IVsHierarchy

A 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.

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:

HRESULT OnGlobalSymbolRenamed(
    [in] IVsHierarchy *pHier,
    [in] VSITEMID itemid,
    [in] ULONG cRQNames,
    [in, size_is(cRQNames)] LPCOLESTR rglpszRQName[],
    [in] LPCOLESTR lpszNewName);

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Share via