IVsChangeTrackingUndoManager.AdviseTrackingClient Method

Article
08/01/2012

Advises the Undo Manager that you want to receive notification when the document is clean.

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

Syntax

'Déclaration
Function AdviseTrackingClient ( _
    pUndoTrackingEvents As IVsUndoTrackingEvents _
) As Integer

int AdviseTrackingClient(
    IVsUndoTrackingEvents pUndoTrackingEvents
)

int AdviseTrackingClient(
    [InAttribute] IVsUndoTrackingEvents^ pUndoTrackingEvents
)

abstract AdviseTrackingClient : 
        pUndoTrackingEvents:IVsUndoTrackingEvents -> int

function AdviseTrackingClient(
    pUndoTrackingEvents : IVsUndoTrackingEvents
) : int

Parameters

pUndoTrackingEvents
Type: Microsoft.VisualStudio.TextManager.Interop.IVsUndoTrackingEvents
[in] Pointer to an undo tracking events object. For more information, see IVsUndoTrackingEvents.

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

HRESULT IVsChangeTrackingUndoManager::AdviseTrackingClient(
   [in] IVsUndoTrackingEvents *pUndoTrackingEvents
);

AdviseTrackingClient tells the Undo Manager to notify the event interface that undo actions have return to an unmodified state.

Note

This method does not call AddRef or Release on pUndoTrackingEvents. Therefore you must call UnadviseTrackingClient before you release your reference to the undo manager.

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

Partager via