IVsAsynchOpenFromScc.LoadProjectAsynchronously(String, Int32) Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.8.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.

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

public:
 int LoadProjectAsynchronously(System::String ^ lpszProjectPath, [Runtime::InteropServices::Out] int % pReturnValue);

int LoadProjectAsynchronously(std::wstring const & lpszProjectPath, [Runtime::InteropServices::Out] int & pReturnValue);

public int LoadProjectAsynchronously (string lpszProjectPath, out int pReturnValue);

abstract member LoadProjectAsynchronously : string * int -> int

Public Function LoadProjectAsynchronously (lpszProjectPath As String, ByRef pReturnValue As Integer) As Integer

Parameters

lpszProjectPath: String

[in] Physical path to the specified project.

pReturnValue: Int32

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

Returns

Int32

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

Remarks

COM Signature

From vsshell80.idl

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.

Applies to