IVsShell.AdviseShellPropertyChanges(IVsShellPropertyEvents, UInt32) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

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

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.11.40262

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.

Enables clients to receive notifications of property changes to the environment.

public:
 int AdviseShellPropertyChanges(Microsoft::VisualStudio::Shell::Interop::IVsShellPropertyEvents ^ pSink, [Runtime::InteropServices::Out] System::UInt32 % pdwCookie);

int AdviseShellPropertyChanges(Microsoft::VisualStudio::Shell::Interop::IVsShellPropertyEvents const & pSink, [Runtime::InteropServices::Out] unsigned int & pdwCookie);

public int AdviseShellPropertyChanges (Microsoft.VisualStudio.Shell.Interop.IVsShellPropertyEvents pSink, out uint pdwCookie);

abstract member AdviseShellPropertyChanges : Microsoft.VisualStudio.Shell.Interop.IVsShellPropertyEvents * uint32 -> int

Public Function AdviseShellPropertyChanges (pSink As IVsShellPropertyEvents, ByRef pdwCookie As UInteger) As Integer

Parameters

pSink: IVsShellPropertyEvents

[in] Pointer to the IVsShellPropertyEvents interface.

pdwCookie: UInt32

[out] Pointer to an abstract handle to the client that will be notified of changes to environment properties

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 IVsShell::AdviseShellPropertyChanges(  
   [in] IVsShellPropertyEvents *pSink,  
   [out] VSCOOKIE *pdwCookie  
);

This same pdwCookie is passed into the call to UnadviseShellPropertyChanges.

Applies to

Share via