IVsSccAddWebProjectFromSourceControl.BrowseForServerLocation Method

Reference

Definition

Namespace:: Microsoft.VisualStudio.Shell.Interop

Assembly:: Microsoft.VisualStudio.Shell.Interop.8.0.dll

Assembly:: Microsoft.VisualStudio.Interop.dll

Package:: Microsoft.VisualStudio.Interop v17.12.40391

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.

Presents a dialog box to the user to browse for a source control server location.

public:
 int BrowseForServerLocation([Runtime::InteropServices::Out] System::String ^ % pbstrLocationDescription, [Runtime::InteropServices::Out] System::String ^ % pbstrLocalPath, [Runtime::InteropServices::Out] System::String ^ % pbstrDatabasePath, [Runtime::InteropServices::Out] System::String ^ % pbstrAuxiliarPath, [Runtime::InteropServices::Out] System::String ^ % pbstrProviderName);

int BrowseForServerLocation([Runtime::InteropServices::Out] std::wstring const & & pbstrLocationDescription, [Runtime::InteropServices::Out] std::wstring const & & pbstrLocalPath, [Runtime::InteropServices::Out] std::wstring const & & pbstrDatabasePath, [Runtime::InteropServices::Out] std::wstring const & & pbstrAuxiliarPath, [Runtime::InteropServices::Out] std::wstring const & & pbstrProviderName);

public int BrowseForServerLocation (out string pbstrLocationDescription, out string pbstrLocalPath, out string pbstrDatabasePath, out string pbstrAuxiliarPath, out string pbstrProviderName);

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

Public Function BrowseForServerLocation (ByRef pbstrLocationDescription As String, ByRef pbstrLocalPath As String, ByRef pbstrDatabasePath As String, ByRef pbstrAuxiliarPath As String, ByRef pbstrProviderName As String) As Integer

Parameters

pbstrLocationDescription: String

[out] Returns a user-friendly description of the returned path (for example, "Project <MyProject> from database <GemSS>").

pbstrLocalPath: String

[out] Returns a suggested local path where the project will be stored. The user can override this string.

pbstrDatabasePath: String

[out] Returns the location of the database (this will not be shown to the user). This value is passed directly to the AddWebProjectFromSourceControl(String, String, String, String, String) method.

pbstrAuxiliarPath: String

[out] Returns an additional path if the source control package requires it. This is passed directly to the AddWebProjectFromSourceControl(String, String, String, String, String) method.

pbstrProviderName: String

[out] Returns a string identifying the source control package being used. This string is passed directly to the AddWebProjectFromSourceControl(String, String, String, String, String) method.

Returns

Int32

If the method succeeds, it returns S_OK. The method returns E_FAIL if the user cancels the dialog box. Otherwise, the method returns an error code.

Remarks

COM Signature

From ivssccaddwebprojectfromsourcecontrol.idl

HRESULT BrowseForServerLocation(  
   [out] BSTR * pbstrLocationDescription,  
   [out] BSTR * pbstrLocalPath,  
   [out] BSTR * pbstrDatabasePath,  
   [out] BSTR * pbstrAuxiliarPath,  
   [out] BSTR * pbstrProviderName  
);

The returned information is used in another browse dialog box (supplied by Visual Studio) in which the user selects a Web-based project to add and the location to store it in. All of this information is passed on to the AddWebProjectFromSourceControl method.

Applies to

Partager via