IVsWebPreview.PreviewURLEx Method

Article
02/04/2013

Provides the information for the preview. Extension of PreviewURL. Use ActivatePreview to display the preview.

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

Syntax

'Declaration
Function PreviewURLEx ( _
    pAction As IVsWebPreviewAction, _
    lpszURL As String, _
    opt As UInteger, _
    cx As Integer, _
    cy As Integer _
) As Integer

int PreviewURLEx(
    IVsWebPreviewAction pAction,
    string lpszURL,
    uint opt,
    int cx,
    int cy
)

int PreviewURLEx(
    [InAttribute] IVsWebPreviewAction^ pAction, 
    [InAttribute] String^ lpszURL, 
    [InAttribute] unsigned int opt, 
    [InAttribute] int cx, 
    [InAttribute] int cy
)

abstract PreviewURLEx : 
        pAction:IVsWebPreviewAction * 
        lpszURL:string * 
        opt:uint32 * 
        cx:int * 
        cy:int -> int

function PreviewURLEx(
    pAction : IVsWebPreviewAction, 
    lpszURL : String, 
    opt : uint, 
    cx : int, 
    cy : int
) : int

Parameters

pAction
Type: Microsoft.VisualStudio.Shell.Interop.IVsWebPreviewAction
[in] [in] Pointer to an IVsWebPreviewAction interface providing callbacks for the preview process. May be nulla null reference (Nothing in Visual Basic).

lpszURL
Type: System.String
[in] Pointer to a string containing the URL to be previewed.

opt
Type: System.UInt32
[in] Integer. Options for displaying the preview window. A value from the __VSWBPREVIEWOPTIONS enumeration.

cx
Type: System.Int32
[in] Integer. Horizontal position of upper left corner of preview. Can be zero (0), the default.

cy
Type: System.Int32
[in] Integer. Vertical position of upper left corner of preview. Can be zero (0), the default.

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 IVsWebPreview::PreviewURLEx(
   [in] IVsWebPreviewAction* pAction, 
   [in] LPCOLESTR lpszURL, 
   [in] VSWBPREVIEWOPTIONS opt, 
   [in] int cx
);

.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.