IVsAsynchOpenFromScc.LoadProjectAsynchronously Method

2014-07-12

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

'Declaration
Function LoadProjectAsynchronously ( _
    lpszProjectPath As String, _
    <OutAttribute> ByRef pReturnValue As Integer _
) As Integer

int LoadProjectAsynchronously(
    string lpszProjectPath,
    out int pReturnValue
)

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

abstract LoadProjectAsynchronously : 
        lpszProjectPath:string * 
        pReturnValue:int byref -> int

function LoadProjectAsynchronously(
    lpszProjectPath : String, 
    pReturnValue : int
) : int

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

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.

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

Share via