IVsChangeTrackingUndoManager.AdviseTrackingClient Method

Definition

Namespace:

Microsoft.VisualStudio.TextManager.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

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

public:
 int AdviseTrackingClient(Microsoft::VisualStudio::TextManager::Interop::IVsUndoTrackingEvents ^ pUndoTrackingEvents);

public:
 int AdviseTrackingClient(Microsoft::VisualStudio::TextManager::Interop::IVsUndoTrackingEvents ^ pUndoTrackingEvents);

int AdviseTrackingClient(Microsoft::VisualStudio::TextManager::Interop::IVsUndoTrackingEvents const & pUndoTrackingEvents);

public int AdviseTrackingClient (Microsoft.VisualStudio.TextManager.Interop.IVsUndoTrackingEvents pUndoTrackingEvents);

abstract member AdviseTrackingClient : Microsoft.VisualStudio.TextManager.Interop.IVsUndoTrackingEvents -> int

Public Function AdviseTrackingClient (pUndoTrackingEvents As IVsUndoTrackingEvents) As Integer

Parameters

pUndoTrackingEvents

IVsUndoTrackingEvents

[in] Pointer to an undo tracking events object. For more information, see IVsUndoTrackingEvents.

Returns

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.