IVsCfgProviderEventsHelper::AdviseCfgProviderEvents Method (IVsCfgProviderEvents^, UInt32)

Visual Studio 2015

Called to add listeners for configuration events to the array.

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

Syntax

C++

int AdviseCfgProviderEvents(
	IVsCfgProviderEvents^ pCPE,
	[OutAttribute] unsigned int% pdwCookie
)

Parameters

pCPE: Type: Microsoft.VisualStudio.Shell.Interop::IVsCfgProviderEvents^
[in] Pointer to IVsCfgProviderEvents object.

pdwCookie: Type: System::UInt32
[out] Pointer to a token representing the completed registration.

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

C++

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.