IVsEditorFactoryNotify.NotifyItemRenamed Method

Article
07/12/2014

Method called when a file is renamed.

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

Syntax

'Declaration
Function NotifyItemRenamed ( _
    pHier As IVsHierarchy, _
    itemid As UInteger, _
    pszMkDocumentOld As String, _
    pszMkDocumentNew As String _
) As Integer

int NotifyItemRenamed(
    IVsHierarchy pHier,
    uint itemid,
    string pszMkDocumentOld,
    string pszMkDocumentNew
)

int NotifyItemRenamed(
    [InAttribute] IVsHierarchy^ pHier, 
    [InAttribute] unsigned int itemid, 
    [InAttribute] String^ pszMkDocumentOld, 
    [InAttribute] String^ pszMkDocumentNew
)

abstract NotifyItemRenamed : 
        pHier:IVsHierarchy * 
        itemid:uint32 * 
        pszMkDocumentOld:string * 
        pszMkDocumentNew:string -> int

function NotifyItemRenamed(
    pHier : IVsHierarchy, 
    itemid : uint, 
    pszMkDocumentOld : String, 
    pszMkDocumentNew : String
) : int

Parameters

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

[in] Pointer to the IVsHierarchy for the renamed item.

itemid
Type: System.UInt32

[in] The item ID (VSITEMID) of the file.

pszMkDocumentOld
Type: System.String

[in] Pointer to a string containing the old name.

pszMkDocumentNew
Type: System.String

[in] Pointer to a string containing the new name.

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 vsshell.idl:

HRESULT IVsEditorFactoryNotify::NotifyItemRenamed(
   in] IVsHierarchy *pHier, 
   [in] VSITEMID itemid, 
   [in] LPCOLESTR pszMkDocumentOld, 
   [in] LPCOLESTR pszMkDocumentNew
);

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