IVsUIShell.GetURLViaDlg(String, String, String, String) Method

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

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

public:
 int GetURLViaDlg(System::String ^ pszDlgTitle, System::String ^ pszStaticLabel, System::String ^ pszHelpTopic, [Runtime::InteropServices::Out] System::String ^ % pbstrURL);

int GetURLViaDlg(std::wstring const & pszDlgTitle, std::wstring const & pszStaticLabel, std::wstring const & pszHelpTopic, [Runtime::InteropServices::Out] std::wstring const & & pbstrURL);

public int GetURLViaDlg (string pszDlgTitle, string pszStaticLabel, string pszHelpTopic, out string pbstrURL);

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

Public Function GetURLViaDlg (pszDlgTitle As String, pszStaticLabel As String, pszHelpTopic As String, ByRef pbstrURL As String) As Integer

Parameters

pszDlgTitle

String

[in] Pointer to the dialog box title.

pszStaticLabel

String

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

pszHelpTopic

String

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

pbstrURL

String

[out] URL entered by the user.

Returns

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.