IVsWebBrowsingService.CreateWebBrowser Method

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

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

Syntax

'Declaration
Function CreateWebBrowser ( _
    dwCreateFlags As UInteger, _
    ByRef rguidOwner As Guid, _
    lpszBaseCaption As String, _
    lpszStartURL As String, _
    pUser As IVsWebBrowserUser, _
    <OutAttribute> ByRef ppBrowser As IVsWebBrowser, _
    <OutAttribute> ByRef ppFrame As IVsWindowFrame _
) As Integer
'Usage
Dim instance As IVsWebBrowsingService 
Dim dwCreateFlags As UInteger 
Dim rguidOwner As Guid 
Dim lpszBaseCaption As String 
Dim lpszStartURL As String 
Dim pUser As IVsWebBrowserUser 
Dim ppBrowser As IVsWebBrowser 
Dim ppFrame As IVsWindowFrame 
Dim returnValue As Integer 

returnValue = instance.CreateWebBrowser(dwCreateFlags, _
    rguidOwner, lpszBaseCaption, lpszStartURL, _
    pUser, ppBrowser, ppFrame)
int CreateWebBrowser(
    uint dwCreateFlags,
    ref Guid rguidOwner,
    string lpszBaseCaption,
    string lpszStartURL,
    IVsWebBrowserUser pUser,
    out IVsWebBrowser ppBrowser,
    out IVsWindowFrame ppFrame
)
int CreateWebBrowser(
    [InAttribute] unsigned int dwCreateFlags, 
    [InAttribute] Guid% rguidOwner, 
    [InAttribute] String^ lpszBaseCaption, 
    [InAttribute] String^ lpszStartURL, 
    [InAttribute] IVsWebBrowserUser^ pUser, 
    [OutAttribute] IVsWebBrowser^% ppBrowser, 
    [OutAttribute] IVsWindowFrame^% ppFrame
)
function CreateWebBrowser(
    dwCreateFlags : uint, 
    rguidOwner : Guid, 
    lpszBaseCaption : String, 
    lpszStartURL : String, 
    pUser : IVsWebBrowserUser, 
    ppBrowser : IVsWebBrowser, 
    ppFrame : IVsWindowFrame
) : int

Parameters

  • rguidOwner
    Type: System.Guid%

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

  • lpszBaseCaption
    Type: System.String

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

  • lpszStartURL
    Type: System.String

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

Return Value

Type: System.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
);

.NET Framework Security

See Also

Reference

IVsWebBrowsingService Interface

IVsWebBrowsingService Members

Microsoft.VisualStudio.Shell.Interop Namespace