IVsTrackProjectDocuments2.AdviseTrackProjectDocumentsEvents Method

Article
2012-10-26

This method enables clients to receive notifications of project documents events.

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

Syntax

'Declaration
Function AdviseTrackProjectDocumentsEvents ( _
    pEventSink As IVsTrackProjectDocumentsEvents2, _
    <OutAttribute> ByRef pdwCookie As UInteger _
) As Integer

'Usage
Dim instance As IVsTrackProjectDocuments2 
Dim pEventSink As IVsTrackProjectDocumentsEvents2 
Dim pdwCookie As UInteger 
Dim returnValue As Integer 

returnValue = instance.AdviseTrackProjectDocumentsEvents(pEventSink, _
    pdwCookie)

int AdviseTrackProjectDocumentsEvents(
    IVsTrackProjectDocumentsEvents2 pEventSink,
    out uint pdwCookie
)

int AdviseTrackProjectDocumentsEvents(
    [InAttribute] IVsTrackProjectDocumentsEvents2^ pEventSink, 
    [OutAttribute] unsigned int% pdwCookie
)

function AdviseTrackProjectDocumentsEvents(
    pEventSink : IVsTrackProjectDocumentsEvents2, 
    pdwCookie : uint
) : int

Parameters

pEventSink
Type: Microsoft.VisualStudio.Shell.Interop.IVsTrackProjectDocumentsEvents2

[in] Pointer to the IVsTrackProjectDocumentsEvents2 interface.

pdwCookie
Type: System.UInt32%

[out] Pointer to an abstract handle that identifies the client to be advised of project documents events.

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

HRESULT IVsTrackProjectDocuments2::AdviseTrackProjectDocumentsEvents(
   [in] IVsTrackProjectDocumentsEvents2 *pEventSink,
   [out] VSCOOKIE *pdwCookie
);

The pdwCookie parameter is passed in with a call to UnadviseTrackProjectDocumentsEvents when the client wants to be unadvised of these events.

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

Share via