IVsSccAddWebProjectFromSourceControl.BrowseForServerLocation Method

2014-07-12

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

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

Syntax

'Declaration
Function BrowseForServerLocation ( _
    <OutAttribute> ByRef pbstrLocationDescription As String, _
    <OutAttribute> ByRef pbstrLocalPath As String, _
    <OutAttribute> ByRef pbstrDatabasePath As String, _
    <OutAttribute> ByRef pbstrAuxiliarPath As String, _
    <OutAttribute> ByRef pbstrProviderName As String _
) As Integer

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

int BrowseForServerLocation(
    [OutAttribute] String^% pbstrLocationDescription, 
    [OutAttribute] String^% pbstrLocalPath, 
    [OutAttribute] String^% pbstrDatabasePath, 
    [OutAttribute] String^% pbstrAuxiliarPath, 
    [OutAttribute] String^% pbstrProviderName
)

abstract BrowseForServerLocation : 
        pbstrLocationDescription:string byref * 
        pbstrLocalPath:string byref * 
        pbstrDatabasePath:string byref * 
        pbstrAuxiliarPath:string byref * 
        pbstrProviderName:string byref -> int

function BrowseForServerLocation(
    pbstrLocationDescription : String, 
    pbstrLocalPath : String, 
    pbstrDatabasePath : String, 
    pbstrAuxiliarPath : String, 
    pbstrProviderName : String
) : int

Parameters

pbstrLocationDescription
Type: System.String%

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

pbstrLocalPath
Type: System.String%

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

pbstrDatabasePath
Type: System.String%

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

pbstrAuxiliarPath
Type: System.String%

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

pbstrProviderName
Type: System.String%

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

Return Value

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

.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