IVsSccProjectEnlistmentFactory::BrowseEnlistment Method (String^, String^, String^, String^)

Visual Studio 2015

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

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

Syntax

C++

int BrowseEnlistment(
	String^ lpszProjectPath,
	String^ lpszInitialEnlistment,
	[OutAttribute] String^% pbstrChosenEnlistment,
	[OutAttribute] String^% pbstrChosenEnlistmentUNC
)

Parameters

lpszProjectPath: Type: System::String^
[in] The original project path.

lpszInitialEnlistment: Type: System::String^
[in] The user's latest edited version of the enlistment choice.

pbstrChosenEnlistment: Type: System::String^
[out] Returns the (possibly) new enlistment choice as chosen by the user.

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

Return Value

Type: System::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

C++

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).