IVsWebBrowsingService.CreateWebBrowserEx 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. Extension of the CreateWebBrowser(UInt32, Guid, String, String, IVsWebBrowserUser, IVsWebBrowser, IVsWindowFrame) method.

public:
 int CreateWebBrowserEx(System::UInt32 dwCreateFlags, Guid % rguidPersistenceSlot, System::UInt32 dwId, 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 CreateWebBrowserEx (uint dwCreateFlags, ref Guid rguidPersistenceSlot, uint dwId, 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 CreateWebBrowserEx : uint32 * Guid * uint32 * string * string * Microsoft.VisualStudio.Shell.Interop.IVsWebBrowserUser * IVsWebBrowser * IVsWindowFrame -> int

Public Function CreateWebBrowserEx (dwCreateFlags As UInteger, ByRef rguidPersistenceSlot As Guid, dwId As UInteger, 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.

rguidPersistenceSlot

Guid

[in] Pointer to the browser window GUID. A window must be registered in order to be saved and restored when Visual Studio starts up. Use GUID_NULL to use the default.

dwId

UInt32

[in] Integer identifier for the window. Use 0 for next available.

lpszBaseCaption

String

[in] Pointer to a string containing the window caption. Use null for the default caption.

lpszStartURL

String

[in] Pointer to a string containing the URL of the page to display. Use null for the default, the Visual Studio home page.

pUser

IVsWebBrowserUser

[in] Pointer to the IVsWebBrowserUser interface to use in controlling the browser. Should be null if you specify GUID_NULL for rguidPersistenceSlot.

ppBrowser

IVsWebBrowser

[out] Pointer to the IVsWebBrowser interface of the browser. May be null.

ppFrame

IVsWindowFrame

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

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::CreateWebBrowserEx(  
   [in] VSCREATEWEBBROWSER dwCreateFlags,   
   [in] REFGUID rguidPersistenceSlot,   
   [in] DWORD dwId,   
   [in] LPCOLESTR lpszBaseCaption,   
   [in] LPCOLESTR lpszStartURL,   
   [in] IVsWebBrowserUser* pUser,   
   [out] IVsWebBrowser** ppBrowser,   
   [out] IVsWindowFrame** ppFrame  
);