IVsCfgProviderEventsHelper.AdviseCfgProviderEvents Method

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

'Declaration
Function AdviseCfgProviderEvents ( _
    pCPE As IVsCfgProviderEvents, _
    <OutAttribute> ByRef pdwCookie As UInteger _
) As Integer
'Usage
Dim instance As IVsCfgProviderEventsHelper 
Dim pCPE As IVsCfgProviderEvents 
Dim pdwCookie As UInteger 
Dim returnValue As Integer 

returnValue = instance.AdviseCfgProviderEvents(pCPE, _
    pdwCookie)
int AdviseCfgProviderEvents(
    IVsCfgProviderEvents pCPE,
    out uint pdwCookie
)
int AdviseCfgProviderEvents(
    [InAttribute] IVsCfgProviderEvents^ pCPE, 
    [OutAttribute] unsigned int% pdwCookie
)
function AdviseCfgProviderEvents(
    pCPE : IVsCfgProviderEvents, 
    pdwCookie : uint
) : int

Parameters

  • 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:

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.

.NET Framework Security

See Also

Reference

IVsCfgProviderEventsHelper Interface

IVsCfgProviderEventsHelper Members

Microsoft.VisualStudio.Shell.Interop Namespace