Partager via


IVsSolution.AdviseSolutionEvents Method

Establishes client notification of solution events.

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

Syntax

'Declaration
Function AdviseSolutionEvents ( _
    pSink As IVsSolutionEvents, _
    <OutAttribute> ByRef pdwCookie As UInteger _
) As Integer
int AdviseSolutionEvents(
    IVsSolutionEvents pSink,
    out uint pdwCookie
)
int AdviseSolutionEvents(
    [InAttribute] IVsSolutionEvents^ pSink, 
    [OutAttribute] unsigned int% pdwCookie
)
abstract AdviseSolutionEvents : 
        pSink:IVsSolutionEvents * 
        pdwCookie:uint32 byref -> int
function AdviseSolutionEvents(
    pSink : IVsSolutionEvents, 
    pdwCookie : uint
) : int

Parameters

  • pdwCookie
    Type: UInt32%

    [out] Unique identifier for the referenced event sink. This value is required to unadvise the event sink using the UnadviseUpdateSolutionEvents method.

Return Value

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

Remarks

COM Signature

From vsshell.idl:

HRESULT IVsSolution::AdviseSolutionEvents(
   [in] IVsSolutionEvents *pSink,
   [out] VSCOOKIE *pdwCookie
);

Use this method to set up notification of solution events on a particular object by synchronizing the solution to the solution events. For example, the Output window contains some panes that provide information about the solution. These panes are closed when the solution is closed. Thus, when the solution close event is received, then the Output window clears the Build pane and the Debug Output pane. For another example, see OnAfterSave.

.NET Framework Security

See Also

Reference

IVsSolution Interface

Microsoft.VisualStudio.Shell.Interop Namespace