Share via


IVsSolutionLoadEvents.OnBeforeBackgroundSolutionLoadBegins Method

Definition

Caution

This API is no longer supported by Visual Studio.

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

public:
 int OnBeforeBackgroundSolutionLoadBegins();
public:
 int OnBeforeBackgroundSolutionLoadBegins();
int OnBeforeBackgroundSolutionLoadBegins();
public int OnBeforeBackgroundSolutionLoadBegins ();
[System.Obsolete("This API is no longer supported by Visual Studio.")]
public int OnBeforeBackgroundSolutionLoadBegins ();
abstract member OnBeforeBackgroundSolutionLoadBegins : unit -> int
[<System.Obsolete("This API is no longer supported by Visual Studio.")>]
abstract member OnBeforeBackgroundSolutionLoadBegins : unit -> int
Public Function OnBeforeBackgroundSolutionLoadBegins () As Integer

Returns

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

Attributes

Remarks

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_guid 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_guid context is deactivated again. When background loading is completed, then the OnAfterBackgroundSolutionLoadComplete event fires, and the SolutionExistsAndFullyLoaded_guid is activated again.

Applies to