IVsRunningDocTableEvents2.OnAfterAttributeChangeEx Method

Article
04/22/2008

Called after a document attribute changes. 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

'Déclaration
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
'Utilisation
Dim instance As IVsRunningDocTableEvents2
Dim docCookie As UInteger
Dim grfAttribs As UInteger
Dim pHierOld As IVsHierarchy
Dim itemidOld As UInteger
Dim pszMkDocumentOld As String
Dim pHierNew As IVsHierarchy
Dim itemidNew As UInteger
Dim pszMkDocumentNew As String
Dim returnValue As Integer

returnValue = instance.OnAfterAttributeChangeEx(docCookie, _
    grfAttribs, pHierOld, itemidOld, _
    pszMkDocumentOld, pHierNew, itemidNew, _
    pszMkDocumentNew)

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
)

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

Parameters

docCookie
Type: System.UInt32

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

grfAttribs
Type: System.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: System.UInt32

[in] Indicates 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: System.String

[in] Name of the old document.

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

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

itemidNew
Type: System.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: System.String

[in] Name of the new document.

Return Value

Type: System.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 IVsRunningDocTableEvents2::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
);

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.

Partager via