IVsTrackProjectDocumentsEvents3 Interface

Receives calls made to the IVsTrackProjectDocuments3 interface. It provides support for batch-processing queries and for coordination of file access.

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

public interface IVsTrackProjectDocumentsEvents3

The IVsTrackProjectDocumentsEvents3 type exposes the following members.

Public methodHandsOffFilesAccesses a specified set of files and asks all implementers of this method to release any locks that may exist on those files.
Public methodHandsOnFilesCalled when a project has completed operations on a set of files.
Public methodOnBeginQueryBatchIndicates that a project is about start a batch query process.
Public methodOnCancelQueryBatchThis method is called to indicate that a batch query process has been canceled.
Public methodOnEndQueryBatchDetermines whether it is okay to proceed with the actual batch operation after successful completion of a batch query process.
Public methodOnQueryAddFilesExDetermines if it is okay to add a collection of files (possibly from source control) whose final destination may be different from a source location.

For every call to OnBeginQueryBatch method, there is a matching call to OnEndQueryBatch method or OnCancelQueryBatch method.

Notes to Implementers

This interface is implemented by any entity that needs to receive events from calls made to the IVsTrackProjectDocuments3 interface in order to coordinate file access with a project. Typically, this entity is a source control package.


This interface is implemented on the same object that implements the IVsTrackProjectDocumentsEvents2 interface and is obtained with a call to the QueryInterface method on the IVsTrackProjectDocumentsEvents2 interface.

Notes to Callers

This interface is called in response to calls made to corresponding methods on the IVsTrackProjectDocuments3 interface. Typically, Visual Studio implements the IVsTrackProjectDocuments3 interface and forwards all calls made to that interface to the current source control package, if that package implements the IVsTrackProjectDocumentsEvents3 interface for handling.

Was this page helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

© 2014 Microsoft