IVsSolutionLoadEvents.OnBeforeBackgroundSolutionLoadBegins Method

Fired when background loading of projects is beginning again after the initial solution open operation has completed.

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

int OnBeforeBackgroundSolutionLoadBegins()

Return Value

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

This event does not fire when a solution is first opened. OnAfterBackgroundSolutionLoadComplete fires after all background loading projects have completed and the initial opening of the solution has reached the SolutionExistsAndFullyLoaded() state. After this point, if a new group of projects begins loading in the background, then this event will fire. This could occur if the user causes the loading of a PLP_LoadIfNeeded project (for example, by expanding the pending project in the Solution Explorer) or if the solution load manager changes an unloaded project's load priority from PLP_ExplicitLoadOnly or PLP_LoadIfNeeded to PLP_BackgroundLoad. When a new group of projects starts loading in the background in this manner, the SolutionExistsAndFullyLoaded() context is deactivated again. When background loading is completed, then the OnAfterBackgroundSolutionLoadComplete event fires, and the SolutionExistsAndFullyLoaded() is activated again.

Community Additions