BeginBatch Method
The document is archived and information here might be outdated

IVsTrackProjectDocuments2.BeginBatch Method

This method starts a batch of IVsTrackProjectDocuments2.OnAfter* method calls.

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

int BeginBatch ()
int BeginBatch ()
function BeginBatch () : int

Return Value

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

COM Signature

From IVsTrackProjectDocuments2.idl

HRESULT BeginBatch();

The IVsTrackProjectDocuments2 interface allows projects to tell the environment when a project item has been added, removed, or renamed. During these operations, user interface (UI) is sometimes displayed. IVsTrackProjectDocuments2.BeginBatch informs the environment that you are going to call several IVsTrackProjectDocuments2.OnAfter* methods, and that you would like the user to receive only one UI display for those calls. Grouping these calls using IVsTrackProjectDocuments2.BeginBatch and EndBatch increases the likelihood that the environment will display only one UI display; however, this is not guaranteed.

Call IVsTrackProjectDocuments2.BeginBatch to start the batch, make multiple IVsTrackProjectDocuments2 calls, and then call EndBatch to display the UI.


You can batch only OnAfter* methods. OnQuery* methods cannot be batched.

© 2016 Microsoft