IVsShell.AdviseShellPropertyChanges Method

Article
03/06/2013

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

'Declaration
Function AdviseShellPropertyChanges ( _
    pSink As IVsShellPropertyEvents, _
    <OutAttribute> ByRef pdwCookie As UInteger _
) As Integer

int AdviseShellPropertyChanges(
    IVsShellPropertyEvents pSink,
    out uint pdwCookie
)

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

abstract AdviseShellPropertyChanges : 
        pSink:IVsShellPropertyEvents * 
        pdwCookie:uint32 byref -> int

function AdviseShellPropertyChanges(
    pSink : IVsShellPropertyEvents, 
    pdwCookie : uint
) : int

Parameters

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

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

This same pdwCookie is passed into the call to UnadviseShellPropertyChanges.

.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.