IVsWebBrowsingService.CreateWebBrowser Method

Definition

Namespace:

Microsoft.VisualStudio.Shell.Interop

Assembly:

Microsoft.VisualStudio.Interop.dll

Package:

Microsoft.VisualStudio.Interop v17.12.40391

Create an instance of a Web browser within the Visual Studio user interface.

public:
 int CreateWebBrowser(System::UInt32 dwCreateFlags, Guid % rguidOwner, System::String ^ lpszBaseCaption, System::String ^ lpszStartURL, Microsoft::VisualStudio::Shell::Interop::IVsWebBrowserUser ^ pUser, [Runtime::InteropServices::Out] Microsoft::VisualStudio::Shell::Interop::IVsWebBrowser ^ % ppBrowser, [Runtime::InteropServices::Out] Microsoft::VisualStudio::Shell::Interop::IVsWindowFrame ^ % ppFrame);

public int CreateWebBrowser (uint dwCreateFlags, ref Guid rguidOwner, string lpszBaseCaption, string lpszStartURL, Microsoft.VisualStudio.Shell.Interop.IVsWebBrowserUser pUser, out Microsoft.VisualStudio.Shell.Interop.IVsWebBrowser ppBrowser, out Microsoft.VisualStudio.Shell.Interop.IVsWindowFrame ppFrame);

abstract member CreateWebBrowser : uint32 * Guid * string * string * Microsoft.VisualStudio.Shell.Interop.IVsWebBrowserUser * IVsWebBrowser * IVsWindowFrame -> int

Public Function CreateWebBrowser (dwCreateFlags As UInteger, ByRef rguidOwner As Guid, lpszBaseCaption As String, lpszStartURL As String, pUser As IVsWebBrowserUser, ByRef ppBrowser As IVsWebBrowser, ByRef ppFrame As IVsWindowFrame) As Integer

Parameters

dwCreateFlags

UInt32

[in] Bit flags specifying browser options. Created using values from the __VSCREATEWEBBROWSER enumeration.

rguidOwner

Guid

[in] The GUID of the owner of the window frame in which the browser appears.

lpszBaseCaption

String

[in] Pointer to a string containing the base (first part) of the caption for the browser window. Default is WebBrowser.

lpszStartURL

String

[in] Pointer to a string containing the URL of the page to display.

pUser

IVsWebBrowserUser

[in] Pointer to the IVsWebBrowserUser interface to use in controlling the browser.

ppBrowser

IVsWebBrowser

[out] Pointer to the IVsWebBrowser interface of the browser.

ppFrame

IVsWindowFrame

[out] Pointer to the window frame (IVsWindowFrame) containing the browser.

Returns

Int32

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

Remarks

COM Signature

From vsbrowse.idl:

HRESULT IVsWebBrowsingService::CreateWebBrowser(  
   [in] VSCREATEWEBBROWSER dwCreateFlags,   
   [in] REFGUID rguidOwner,   
   [in] LPCOLESTR lpszBaseCaption,   
   [in] LPCOLESTR lpszStartURL,   
   [in] IVsWebBrowserUser* pUser,   
   [out] IVsWebBrowser** ppBrowser,   
   [out] IVsWindowFrame** ppFrame  
);