IVsHierarchyRefactorNotify.OnGlobalSymbolRenamed Method

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

'宣言
Function OnGlobalSymbolRenamed ( _
    cItemsAffected As UInteger, _
    rgItemsAffected As UInteger(), _
    cRQNames As UInteger, _
    rglpszRQName As String(), _
    lpszNewName As String _
) As Integer
'使用
Dim instance As IVsHierarchyRefactorNotify
Dim cItemsAffected As UInteger
Dim rgItemsAffected As UInteger()
Dim cRQNames As UInteger
Dim rglpszRQName As String()
Dim lpszNewName As String
Dim returnValue As Integer

returnValue = instance.OnGlobalSymbolRenamed(cItemsAffected, _
    rgItemsAffected, cRQNames, rglpszRQName, _
    lpszNewName)

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
)

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

Parameters

• cItemsAffected
  Type: System.UInt32

  The number of files affected by the rename.

• rgItemsAffected
  Type: []

  An array of VSITEMIDs that identifies the affected files.

• 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: []

  The name of the symbol before rename.

• lpszNewName
  Type: System.String

  The 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

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

Permissions

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

See Also

Reference

IVsHierarchyRefactorNotify Interface

IVsHierarchyRefactorNotify Members

Microsoft.VisualStudio.Shell.Interop Namespace