IVsWebBrowsingService.CreateWebBrowserEx Method

Article
03/06/2013

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)

Syntax

'Declaration
Function CreateWebBrowserEx ( _
    dwCreateFlags As UInteger, _
    ByRef rguidPersistenceSlot As Guid, _
    dwId As UInteger, _
    lpszBaseCaption As String, _
    lpszStartURL As String, _
    pUser As IVsWebBrowserUser, _
    <OutAttribute> ByRef ppBrowser As IVsWebBrowser, _
    <OutAttribute> ByRef ppFrame As IVsWindowFrame _
) As Integer

int CreateWebBrowserEx(
    uint dwCreateFlags,
    ref Guid rguidPersistenceSlot,
    uint dwId,
    string lpszBaseCaption,
    string lpszStartURL,
    IVsWebBrowserUser pUser,
    out IVsWebBrowser ppBrowser,
    out IVsWindowFrame ppFrame
)

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

abstract CreateWebBrowserEx : 
        dwCreateFlags:uint32 * 
        rguidPersistenceSlot:Guid byref * 
        dwId:uint32 * 
        lpszBaseCaption:string * 
        lpszStartURL:string * 
        pUser:IVsWebBrowserUser * 
        ppBrowser:IVsWebBrowser byref * 
        ppFrame:IVsWindowFrame byref -> int

function CreateWebBrowserEx(
    dwCreateFlags : uint, 
    rguidPersistenceSlot : Guid, 
    dwId : uint, 
    lpszBaseCaption : String, 
    lpszStartURL : String, 
    pUser : IVsWebBrowserUser, 
    ppBrowser : IVsWebBrowser, 
    ppFrame : IVsWindowFrame
) : int

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 nulla null reference (Nothing in Visual Basic) for the default caption.

lpszStartURL
Type: System.String
[in] Pointer to a string containing the URL of the page to display. Use nulla null reference (Nothing in Visual Basic) 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 nulla null reference (Nothing in Visual Basic) 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 nulla null reference (Nothing in Visual Basic).

ppFrame
Type: Microsoft.VisualStudio.Shell.Interop.IVsWindowFrame%
[out] Pointer to the window frame (IVsWindowFrame) containing the browser. May be nulla null reference (Nothing in Visual Basic).

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::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
);

.NET Framework Security

Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.