Share via


IVsShell.AdviseShellPropertyChanges(IVsShellPropertyEvents, UInt32) Method

Definition

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

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