IVsSccProjectEnlistmentFactory.BrowseEnlistment Method

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.9.37000

Displays a browse dialog box allowing the user to change the enlistment choice.

public:
 int BrowseEnlistment(System::String ^ lpszProjectPath, System::String ^ lpszInitialEnlistment, [Runtime::InteropServices::Out] System::String ^ % pbstrChosenEnlistment, [Runtime::InteropServices::Out] System::String ^ % pbstrChosenEnlistmentUNC);

int BrowseEnlistment(std::wstring const & lpszProjectPath, std::wstring const & lpszInitialEnlistment, [Runtime::InteropServices::Out] std::wstring const & & pbstrChosenEnlistment, [Runtime::InteropServices::Out] std::wstring const & & pbstrChosenEnlistmentUNC);

public int BrowseEnlistment (string lpszProjectPath, string lpszInitialEnlistment, out string pbstrChosenEnlistment, out string pbstrChosenEnlistmentUNC);

abstract member BrowseEnlistment : string * string * string * string -> int

Public Function BrowseEnlistment (lpszProjectPath As String, lpszInitialEnlistment As String, ByRef pbstrChosenEnlistment As String, ByRef pbstrChosenEnlistmentUNC As String) As Integer

Parameters

lpszProjectPath

String

[in] The original project path.

lpszInitialEnlistment

String

[in] The user's latest edited version of the enlistment choice.

pbstrChosenEnlistment

String

[out] Returns the (possibly) new enlistment choice as chosen by the user.

pbstrChosenEnlistmentUNC

String

[out] Returns the enlistment choice as a fully qualified path (UNC-style, [drive:]\path, or file://path).

Returns

Int32

If the method succeeds, it returns S_OK. It returns S_FALSE if the browse dialog box was canceled. If it fails, this method returns an error code.

Remarks

COM Signature

From ivssccprojectenlistmentfactory.idl

HRESULT BrowseEnlistment(  
   [in] LPCOLESTR lpszProjectPath,  
   [in] LPCOLESTR lpszInitialEnlistment,  
   [out] BSTR * pbstrChosenEnlistment,  
   [out] BSTR * pbstrChosenEnlistmentUNC  
);  

The user can browse for the enlistment choice by clicking a Browse button in the dialog box that provides the option of making the enlistment choice. This Browse button is displayed only if the project type supports a call to this method (which is indicated by one of the flags returned by GetEnlistmentFactoryOptions method).