IVsTrackProjectDocumentsEvents3 Interface

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.8.0.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.11.40262

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public interface class IVsTrackProjectDocumentsEvents3

public interface class IVsTrackProjectDocumentsEvents3

__interface IVsTrackProjectDocumentsEvents3

[System.Runtime.InteropServices.Guid("53544C4D-BD74-4D21-A79F-2C190E38AB6F")]
[System.Runtime.InteropServices.InterfaceType(1)]
public interface IVsTrackProjectDocumentsEvents3

[<System.Runtime.InteropServices.Guid("53544C4D-BD74-4D21-A79F-2C190E38AB6F")>]
[<System.Runtime.InteropServices.InterfaceType(1)>]
type IVsTrackProjectDocumentsEvents3 = interface

Public Interface IVsTrackProjectDocumentsEvents3

Attributes: GuidAttribute InterfaceTypeAttribute

Remarks

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(IntPtr, Guid, IntPtr) 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.

Methods

HandsOffFiles(UInt32, Int32, String[])	Accesses a specified set of files and asks all implementers of this method to release any locks that may exist on those files.
HandsOnFiles(Int32, String[])	Called when a project has completed operations on a set of files.
OnBeginQueryBatch()	Indicates that a project is about start a batch query process.
OnCancelQueryBatch()	This method is called to indicate that a batch query process has been canceled.
OnEndQueryBatch(Int32)	Determines whether it is okay to proceed with the actual batch operation after successful completion of a batch query process.
OnQueryAddFilesEx(IVsProject, Int32, String[], String[], VSQUERYADDFILEFLAGS[], VSQUERYADDFILERESULTS[], VSQUERYADDFILERESULTS[])	Determines if it is okay to add a collection of files (possibly from source control) whose final destination may be different from a source location.

Applies to

Share via