IVsShell::AdviseShellPropertyChanges Method (IVsShellPropertyEvents^, UInt32)

Visual Studio 2015

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

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

Syntax

int AdviseShellPropertyChanges(
	IVsShellPropertyEvents^ pSink,
	[OutAttribute] unsigned int% pdwCookie
)

pSink: Type: Microsoft.VisualStudio.Shell.Interop::IVsShellPropertyEvents^
[in] Pointer to the IVsShellPropertyEvents interface.

pdwCookie: Type: System::UInt32
[out] Pointer to an abstract handle to the client that will be notified of changes to environment properties

Type: System::Int32

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

From vsshell.idl:

HRESULT IVsShell::AdviseShellPropertyChanges(
   [in] IVsShellPropertyEvents *pSink,
   [out] VSCOOKIE *pdwCookie
);

This same pdwCookie is passed into the call to UnadviseShellPropertyChanges.