IVsSolutionLoadEvents.OnBeforeLoadProjectBatch(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 when loading a batch of dependent projects as part of loading a solution in the background.

public:
 int OnBeforeLoadProjectBatch(bool fIsBackgroundIdleBatch);

public:
 int OnBeforeLoadProjectBatch(bool fIsBackgroundIdleBatch);

int OnBeforeLoadProjectBatch(bool fIsBackgroundIdleBatch);

public int OnBeforeLoadProjectBatch (bool fIsBackgroundIdleBatch);

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

abstract member OnBeforeLoadProjectBatch : bool -> int

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

Public Function OnBeforeLoadProjectBatch (fIsBackgroundIdleBatch As Boolean) As Integer

Parameters

fIsBackgroundIdleBatch: Boolean

true if the batch is loaded in the background, otherwise false.

Returns

Int32

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

Attributes: ObsoleteAttribute

Remarks

Some batches may be loaded synchronously to satisfy user demand load requests; other batches are loaded in the background at idle time. Clients may request that background batch project loading be delayed if they have higher-priority idle time tasks. The OnQueryBackgroundLoadProjectBatch event is fired only for background batches.

Examples of user demand load requests (that is, synchronous, not background batches) include:

The projects required to open the documents in the .suo open document list are loaded synchronously during the initial solution open operation.
When the user expands a "(pending)" project in the Solution Explorer, that project and all of its dependencies are opened synchronously.
Before building the solution, the Startup project(s) and all build dependencies are loaded.

Clients should defer expensive operations normally done during OnAfterOpenProject until they receive OnAfterLoadProjectBatch.

Applies to