This documentation is archived and is not being maintained.

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)

int GetURLViaDlg (
	[InAttribute] string pszDlgTitle,
	[InAttribute] string pszStaticLabel,
	[InAttribute] string pszHelpTopic,
	out string pbstrURL
)
int GetURLViaDlg (
	/** @attribute InAttribute() */ String pszDlgTitle, 
	/** @attribute InAttribute() */ String pszStaticLabel, 
	/** @attribute InAttribute() */ String pszHelpTopic, 
	/** @attribute OutAttribute() */ /** @ref */ String pbstrURL
)
JScript does not support passing value-type arguments by reference.

Parameters

pszDlgTitle

[in] Pointer to the dialog box title.

pszStaticLabel

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

pszHelpTopic

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

pbstrURL

[out] URL entered by the user.

Return Value

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

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.

Show: