IVsTrackProjectDocuments2.BeginBatch Method
This method starts a batch of IVsTrackProjectDocuments2.OnAfter* method calls.
Namespace: Microsoft.VisualStudio.Shell.Interop
Assembly: Microsoft.VisualStudio.Shell.Interop (in Microsoft.VisualStudio.Shell.Interop.dll)
Syntax
'Declaration
Function BeginBatch As Integer
int BeginBatch()
int BeginBatch()
abstract BeginBatch : unit -> int
function BeginBatch() : int
Return Value
Type: System.Int32
If the method succeeds, it returns S_OK. If it fails, it returns an error code.
Remarks
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.
Note
You can batch only OnAfter* methods. OnQuery* methods cannot be batched.
.NET Framework Security
- Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.