次の方法で共有


IVsSolutionLoadEvents.OnBeforeLoadProjectBatch(Boolean) Method

Definition

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

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

Attributes

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