Share via

IVsSolutionLoadEvents.OnQueryBackgroundLoadProjectBatch Method

Fired before background loading a batch of projects. Normally a background batch loads a single pending project. This is a cancelable event.

Namespace:  Microsoft.VisualStudio.Shell.Interop
Assembly:  Microsoft.VisualStudio.Shell.Interop.10.0 (in Microsoft.VisualStudio.Shell.Interop.10.0.dll)


Function OnQueryBackgroundLoadProjectBatch ( _
    <OutAttribute> ByRef pfShouldDelayLoadToNextIdle As Boolean _
) As Integer
int OnQueryBackgroundLoadProjectBatch(
    out bool pfShouldDelayLoadToNextIdle
int OnQueryBackgroundLoadProjectBatch(
    [OutAttribute] bool% pfShouldDelayLoadToNextIdle
abstract OnQueryBackgroundLoadProjectBatch : 
        pfShouldDelayLoadToNextIdle:bool byref -> int
function OnQueryBackgroundLoadProjectBatch(
    pfShouldDelayLoadToNextIdle : boolean
) : int


  • pfShouldDelayLoadToNextIdle
    Type: System.Boolean%

    [out] true if other background operations should complete before starting to load the project, otherwise false.

Return Value

Type: System.Int32
If the method succeeds, it returns S_OK. If it fails, it returns an error code.


Clients of this event can cause the start of the batch loading to be delayed in order to ensure that other background operations complete before a new batch of projects starts to load by returning true for pfShouldDelayLoadToNextIdle. For example, a project system may want to ensure that the IntelliSense state for the currently loaded projects is up-to-date before starting new background load operations.

.NET Framework Security

See Also


IVsSolutionLoadEvents Interface

Microsoft.VisualStudio.Shell.Interop Namespace