IVsCfgProvider2.AdviseCfgProviderEvents Method

Article
2013-03-06

Registers the caller for configuration event notification.

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

int AdviseCfgProviderEvents(
    IVsCfgProviderEvents pCPE,
    out uint pdwCookie
)

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

abstract AdviseCfgProviderEvents : 
        pCPE:IVsCfgProviderEvents * 
        pdwCookie:uint32 byref -> int

function AdviseCfgProviderEvents(
    pCPE : IVsCfgProviderEvents, 
    pdwCookie : uint
) : int

Parameters

pCPE
Type: Microsoft.VisualStudio.Shell.Interop.IVsCfgProviderEvents
[in] Pointer to the IVsCfgProviderEvents interface to be called to provide notification of configuration events.

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 IVsCfgProvider2::AdviseCfgProviderEvents(
   [in] IVsCfgProviderEvents *pCPE,
   [out] VSCOOKIE *pdwCookie
);

AdviseCfgProviderEvents is called by the environment. The environment implements the five methods of IVsCfgProviderEvents — one for each type of configuration event. For example, when a platform name is added, the project responsible for the change calls OnPlatformNameAdded.

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Share via