IVsTrackProjectDocumentsEvents3.OnBeginQueryBatch Method

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Indicates that a project is about start a batch query process.

public:
 int OnBeginQueryBatch();

public:
 int OnBeginQueryBatch();

int OnBeginQueryBatch();

public int OnBeginQueryBatch ();

abstract member OnBeginQueryBatch : unit -> int

Public Function OnBeginQueryBatch () As Integer

Returns

Int32

If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From ivstrackprojectdocumentsevents80.idl

HRESULT OnBeginQueryBatch(void);  

This method is called as a result of a call to the BeginQueryBatch method.

This method does whatever setup is necessary to watch a batch query process. When the batch query process is over, the OnEndQueryBatch method or the OnCancelQueryBatch method is called, and those methods can clean up any allocations made in OnBeginQueryBatch).

For every call to this method, there is a corresponding call to either the OnEndQueryBatch method or the OnCancelQueryBatch method.