IVsRunningDocTableEvents3.OnAfterAttributeChangeEx Method

Article
04/29/2015

Called after a document attribute is changed. This is an advanced version of the OnAfterAttributeChange method.

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

Syntax

'Declaration
Function OnAfterAttributeChangeEx ( _
    docCookie As UInteger, _
    grfAttribs As UInteger, _
    pHierOld As IVsHierarchy, _
    itemidOld As UInteger, _
    pszMkDocumentOld As String, _
    pHierNew As IVsHierarchy, _
    itemidNew As UInteger, _
    pszMkDocumentNew As String _
) As Integer

int OnAfterAttributeChangeEx(
    uint docCookie,
    uint grfAttribs,
    IVsHierarchy pHierOld,
    uint itemidOld,
    string pszMkDocumentOld,
    IVsHierarchy pHierNew,
    uint itemidNew,
    string pszMkDocumentNew
)

int OnAfterAttributeChangeEx(
    [InAttribute] unsigned int docCookie, 
    [InAttribute] unsigned int grfAttribs, 
    [InAttribute] IVsHierarchy^ pHierOld, 
    [InAttribute] unsigned int itemidOld, 
    [InAttribute] String^ pszMkDocumentOld, 
    [InAttribute] IVsHierarchy^ pHierNew, 
    [InAttribute] unsigned int itemidNew, 
    [InAttribute] String^ pszMkDocumentNew
)

abstract OnAfterAttributeChangeEx : 
        docCookie:uint32 * 
        grfAttribs:uint32 * 
        pHierOld:IVsHierarchy * 
        itemidOld:uint32 * 
        pszMkDocumentOld:string * 
        pHierNew:IVsHierarchy * 
        itemidNew:uint32 * 
        pszMkDocumentNew:string -> int

function OnAfterAttributeChangeEx(
    docCookie : uint, 
    grfAttribs : uint, 
    pHierOld : IVsHierarchy, 
    itemidOld : uint, 
    pszMkDocumentOld : String, 
    pHierNew : IVsHierarchy, 
    itemidNew : uint, 
    pszMkDocumentNew : String
) : int

Parameters

docCookie
Type: UInt32

[in] Abstract value representing the document whose attributes have changed.

grfAttribs
Type: UInt32

[in] Flags corresponding to the changed attributes. Values are taken from the __VSRDTATTRIB enumeration.

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

[in] The IVsHierarchy interface that previously owned the document.

itemidOld
Type: UInt32

[in] The previous item identifier. This is a unique identifier or it can be one of the following values: VSITEMID_NIL, VSITEMID_ROOT, or VSITEMID_SELECTION.

pszMkDocumentOld
Type: String

[in] Name of the old document.

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

[in] The current IVsHierarchy interface that owns the document.

itemidNew
Type: UInt32

[in] Indicates the new item identifier. This is a unique identifier or it can be one of the following values: VSITEMID_NIL, VSITEMID_ROOT, or VSITEMID_SELECTION.

pszMkDocumentNew
Type: String

[in] Name of the new document.

Return Value

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

Remarks

This version of the OnAfterAttributeChange method includes information about the renaming process, if a rename occurred.

This method is called when a document's attributes have changed. Several things can change a document's attributes:

Calling the NotifyDocumentChanged method in the IVsRunningDocumentTable interface.
Calling the RegisterAndLockDocument and RenameDocument methods.
Changing the caption on the document's window.

COM Signature

From vsshell.idl:

HRESULT IVsRunningDocTableEvents3::OnAfterAttributeChangeEx(
   [in] VSCOOKIE docCookie,
   [in] VSRDTATTRIB grfAttribs,
   [in] IVsHierarchy *pHierOld,
   [in] VSITEMID itemidOld,
   [in] LPCOLESTR pszMkDocumentOld,
   [in] IVsHierarchy *pHierNew,
   [in] VSITEMID itemidNew,
   [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.