IVsAsynchOpenFromScc::LoadProjectAsynchronously Method (String^, Int32)

Visual Studio 2015

This method determines whether a specified project must be loaded asynchronously.

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

Syntax

C++

int LoadProjectAsynchronously(
	String^ lpszProjectPath,
	[OutAttribute] int% pReturnValue
)

Parameters

lpszProjectPath: Type: System::String^
[in] Physical path to the specified project.

pReturnValue: Type: System::Int32
[out] Returns nonzero (true) if the project must be loaded asynchronously. Otherwise, returns zero (false) if the project can be loaded synchronously.

Return Value

Type: System::Int32

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

Remarks

COM Signature

From vsshell80.idl

C++

HRESULT LoadProjectAsynchronously(
   [in] LPCOLESTR lpszProjectPath,
   [out] BOOL *pReturnValue
);

One reason a project might need to be loaded asynchronously is a slow connection to the source control, which means that it could take a long time for the project to be loaded. Another possibility is that multiple projects must be loaded one at a time from source control, which would also slow the loading process.