IVsUIShell.GetURLViaDlg Method

Brings up Open Project From Web dialog box to obtain a URL from a user.

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

Syntax

'Declaration
Function GetURLViaDlg ( _
    pszDlgTitle As String, _
    pszStaticLabel As String, _
    pszHelpTopic As String, _
    <OutAttribute> ByRef pbstrURL As String _
) As Integer
int GetURLViaDlg(
    string pszDlgTitle,
    string pszStaticLabel,
    string pszHelpTopic,
    out string pbstrURL
)
int GetURLViaDlg(
    [InAttribute] String^ pszDlgTitle, 
    [InAttribute] String^ pszStaticLabel, 
    [InAttribute] String^ pszHelpTopic, 
    [OutAttribute] String^% pbstrURL
)
abstract GetURLViaDlg : 
        pszDlgTitle:string * 
        pszStaticLabel:string * 
        pszHelpTopic:string * 
        pbstrURL:string byref -> int
function GetURLViaDlg(
    pszDlgTitle : String, 
    pszStaticLabel : String, 
    pszHelpTopic : String, 
    pbstrURL : String
) : int

Parameters

  • pszDlgTitle
    Type: String

    [in] Pointer to the dialog box title.

  • pszStaticLabel
    Type: String

    [in] Pointer to the static label above the drop-down list box.

  • pszHelpTopic
    Type: String

    [in] An F1 keyword that points to a specific Help topic for this dialog box.

  • pbstrURL
    Type: String%

    [out] URL entered by the user.

Return Value

Type: Int32
If the method succeeds, it returns S_OK. If it fails, it returns an error code.

Remarks

COM Signature

From vsshell.idl:

HRESULT IVsUIShell::GetURLViaDlg(
   [in] LPCOLESTR pszDlgTitle,
   [in] LPCOLESTR pszStaticLabel,
   [in] LPCOLESTR pszHelpTopic,
   [out] BSTR *pbstrURL
);

This method brings up the Open Project From Web dialog box, which is accessed by choosing Open from the File menu and then choosing Project From Web. You can change the title of this dialog box to something other than "Open Project From Web" by passing the new title in the pszDlgTitle parameter.

.NET Framework Security

See Also

Reference

IVsUIShell Interface

Microsoft.VisualStudio.Shell.Interop Namespace