IVsWebBrowsingService::CreateWebBrowserEx Method (UInt32, Guid, UInt32, String^, String^, IVsWebBrowserUser^, IVsWebBrowser^, IVsWindowFrame^)

 

Create an instance of a Web browser. Extension of the CreateWebBrowser method.

Namespace:   Microsoft.VisualStudio.Shell.Interop
Assembly:  Microsoft.VisualStudio.Shell.Interop (in Microsoft.VisualStudio.Shell.Interop.dll)

int CreateWebBrowserEx(
	unsigned int dwCreateFlags,
	[InAttribute] Guid% rguidPersistenceSlot,
	unsigned int dwId,
	String^ lpszBaseCaption,
	String^ lpszStartURL,
	IVsWebBrowserUser^ pUser,
	[OutAttribute] IVsWebBrowser^% ppBrowser,
	[OutAttribute] IVsWindowFrame^% ppFrame
)

Parameters

dwCreateFlags
Type: System::UInt32

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

rguidPersistenceSlot
Type: System::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
Type: System::UInt32

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

lpszBaseCaption
Type: System::String^

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

lpszStartURL
Type: System::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
Type: Microsoft.VisualStudio.Shell.Interop::IVsWebBrowserUser^

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

ppBrowser
Type: Microsoft.VisualStudio.Shell.Interop::IVsWebBrowser^

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

ppFrame
Type: Microsoft.VisualStudio.Shell.Interop::IVsWindowFrame^

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

Return Value

Type: System::Int32

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

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
);
Return to top
Show: