IVsSccProjectEnlistmentFactory.BrowseEnlistment Method
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
'Declaration
Function BrowseEnlistment ( _
lpszProjectPath As String, _
lpszInitialEnlistment As String, _
<OutAttribute> ByRef pbstrChosenEnlistment As String, _
<OutAttribute> ByRef pbstrChosenEnlistmentUNC As String _
) As Integer
int BrowseEnlistment(
string lpszProjectPath,
string lpszInitialEnlistment,
out string pbstrChosenEnlistment,
out string pbstrChosenEnlistmentUNC
)
int BrowseEnlistment(
[InAttribute] String^ lpszProjectPath,
[InAttribute] String^ lpszInitialEnlistment,
[OutAttribute] String^% pbstrChosenEnlistment,
[OutAttribute] String^% pbstrChosenEnlistmentUNC
)
abstract BrowseEnlistment :
lpszProjectPath:string *
lpszInitialEnlistment:string *
pbstrChosenEnlistment:string byref *
pbstrChosenEnlistmentUNC:string byref -> int
function BrowseEnlistment(
lpszProjectPath : String,
lpszInitialEnlistment : String,
pbstrChosenEnlistment : String,
pbstrChosenEnlistmentUNC : String
) : int
Parameters
lpszProjectPath
Type: String[in] The original project path.
lpszInitialEnlistment
Type: String[in] The user's latest edited version of the enlistment choice.
pbstrChosenEnlistment
Type: String%[out] Returns the (possibly) new enlistment choice as chosen by the user.
pbstrChosenEnlistmentUNC
Type: String%[out] Returns the enlistment choice as a fully qualified path (UNC-style, [drive:]\path, or file://path).
Return Value
Type: 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).
.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.