IVsSolutionLoadEvents.OnQueryBackgroundLoadProjectBatch(Boolean) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assemblies:: Microsoft.VisualStudio.Shell.14.0.dll, Microsoft.VisualStudio.Shell.Interop.10.0.dll

Assemblies:: Microsoft.VisualStudio.Shell.15.0.dll, Microsoft.VisualStudio.Shell.Interop.10.0.dll

Assembly:: Microsoft.VisualStudio.Shell.Interop.10.0.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Caution

This API is no longer supported by Visual Studio.

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

public:
 int OnQueryBackgroundLoadProjectBatch([Runtime::InteropServices::Out] bool % pfShouldDelayLoadToNextIdle);

int OnQueryBackgroundLoadProjectBatch([Runtime::InteropServices::Out] bool & pfShouldDelayLoadToNextIdle);

public int OnQueryBackgroundLoadProjectBatch (out bool pfShouldDelayLoadToNextIdle);

[System.Obsolete("This API is no longer supported by Visual Studio.")]
public int OnQueryBackgroundLoadProjectBatch (out bool pfShouldDelayLoadToNextIdle);

abstract member OnQueryBackgroundLoadProjectBatch : bool -> int

[<System.Obsolete("This API is no longer supported by Visual Studio.")>]
abstract member OnQueryBackgroundLoadProjectBatch : bool -> int

Public Function OnQueryBackgroundLoadProjectBatch (ByRef pfShouldDelayLoadToNextIdle As Boolean) As Integer

Parameters

pfShouldDelayLoadToNextIdle: Boolean

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

Returns

Int32

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

Attributes: ObsoleteAttribute

Remarks

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.

Applies to