This documentation is archived and is not being maintained.

IVsTrackProjectDocuments2.EndBatch Method

This method ends the batch started by BeginBatch and displays any user interface (UI) that was generated within the batch.

Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop (in microsoft.visualstudio.shell.interop.dll)

int EndBatch ()
int EndBatch ()
function EndBatch () : 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 EndBatch();

The IVsTrackProjectDocuments2 interface allows projects to tell the environment when a project item has been added, removed, or renamed. During these operations, UI is sometimes displayed. 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. Batching these calls using BeginBatch and IVsTrackProjectDocuments2.EndBatch increases the likelihood that the environment will display only one UI display; however, this is not guaranteed.

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

NoteNote

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

Show: