IVsTextView.AddCommandFilter(IOleCommandTarget, IOleCommandTarget) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.TextManager.Interop

Assembly:: Microsoft.VisualStudio.TextManager.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Adds a command filter to the existing chain of command filters.

public:
 int AddCommandFilter(Microsoft::VisualStudio::OLE::Interop::IOleCommandTarget ^ pNewCmdTarg, [Runtime::InteropServices::Out] Microsoft::VisualStudio::OLE::Interop::IOleCommandTarget ^ % ppNextCmdTarg);

public:
 int AddCommandFilter(Microsoft::VisualStudio::OLE::Interop::IOleCommandTarget ^ pNewCmdTarg, [Runtime::InteropServices::Out] Microsoft::VisualStudio::OLE::Interop::IOleCommandTarget ^ &  ppNextCmdTarg);

int AddCommandFilter(Microsoft::VisualStudio::OLE::Interop::IOleCommandTarget const & pNewCmdTarg, [Runtime::InteropServices::Out] Microsoft::VisualStudio::OLE::Interop::IOleCommandTarget const & & ppNextCmdTarg);

public int AddCommandFilter (Microsoft.VisualStudio.OLE.Interop.IOleCommandTarget pNewCmdTarg, out Microsoft.VisualStudio.OLE.Interop.IOleCommandTarget ppNextCmdTarg);

abstract member AddCommandFilter : Microsoft.VisualStudio.OLE.Interop.IOleCommandTarget * IOleCommandTarget -> int

Public Function AddCommandFilter (pNewCmdTarg As IOleCommandTarget, ByRef ppNextCmdTarg As IOleCommandTarget) As Integer

Parameters

pNewCmdTarg: IOleCommandTarget

[in] Pointer to the new command filter (IOleCommandTarget) to add to the command filter chain.

ppNextCmdTarg: IOleCommandTarget

[out] Pointer to a command filter used to handle commands not dealt with by the pNewCmdTarg command filter.

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 IVsTextView::AddCommandFilter(  
   [in] IOleCommandTarget *pNewCmdTarg,   
   [out] IOleCommandTarget **ppNextCmdTarg  
);

The text view uses a chain architecture for command filters. Call AddCommandFilter to add a new command filter to the chain and to handle commands for the text view. The environment then returns a pointer to another command filter. Use this second command filter to handle all of the commands that you do not want to send to your command filter.

To discontinue command handling, call RemoveCommandFilter.

Applies to