IVsChangeTrackingUndoManager::AdviseTrackingClient Method (IVsUndoTrackingEvents^)

Visual Studio 2015

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

C++

int AdviseTrackingClient(
	IVsUndoTrackingEvents^ pUndoTrackingEvents
)

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:

C++

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.