IVsCfgProviderEventsHelper.AdviseCfgProviderEvents Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.9.37000

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.

Called to add listeners for configuration events to the array.

public:
 int AdviseCfgProviderEvents(Microsoft::VisualStudio::Shell::Interop::IVsCfgProviderEvents ^ pCPE, [Runtime::InteropServices::Out] System::UInt32 % pdwCookie);

int AdviseCfgProviderEvents(Microsoft::VisualStudio::Shell::Interop::IVsCfgProviderEvents const & pCPE, [Runtime::InteropServices::Out] unsigned int & pdwCookie);

public int AdviseCfgProviderEvents (Microsoft.VisualStudio.Shell.Interop.IVsCfgProviderEvents pCPE, out uint pdwCookie);

abstract member AdviseCfgProviderEvents : Microsoft.VisualStudio.Shell.Interop.IVsCfgProviderEvents * uint32 -> int

Public Function AdviseCfgProviderEvents (pCPE As IVsCfgProviderEvents, ByRef pdwCookie As UInteger) As Integer

Parameters

pCPE: IVsCfgProviderEvents

[in] Pointer to IVsCfgProviderEvents object.

pdwCookie: UInt32

[out] Pointer to a token representing the completed registration.

Returns

Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From vsshell.idl:

HRESULT IVsCfgProviderEventsHelper::AdviseCfgProviderEvents(  
   [in] IVsCfgProviderEvents *pCPE,  
   [out] VSCOOKIE *pdwCookie  
);

This method is called through IVsCfgProvider2 to add listeners to the array of clients to be notified of configuration events. If the object (IVsCfgProviderEventsHelper) has not yet been instantiated, it should be created with the first call to this method. Subsequent calls will add clients to the array of listeners.

Applies to

Share via