IVsUIShell.GetURLViaDlg Method

Article
05/06/2010

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

'Déclaration
Function GetURLViaDlg ( _
    pszDlgTitle As String, _
    pszStaticLabel As String, _
    pszHelpTopic As String, _
    <OutAttribute> ByRef pbstrURL As String _
) As Integer
'Utilisation
Dim instance As IVsUIShell
Dim pszDlgTitle As String
Dim pszStaticLabel As String
Dim pszHelpTopic As String
Dim pbstrURL As String
Dim returnValue As Integer

returnValue = instance.GetURLViaDlg(pszDlgTitle, _
    pszStaticLabel, pszHelpTopic, pbstrURL)

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: System.String
[in] Pointer to the dialog box title.

pszStaticLabel
Type: System.String
[in] Pointer to the static label above the drop-down list box.

pszHelpTopic
Type: System.String
[in] An F1 keyword that points to a specific Help topic for this dialog box. For more information, see F1 Keywords Overview.

pbstrURL
Type: System.String%
[out] URL entered by the user.

Return Value

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

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.

Partager via