IVsWindowFrame.GetFramePos Method

Article
2013-03-06

Returns the position of the window.

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

Syntax

'Declaration
Function GetFramePos ( _
    <OutAttribute> pdwSFP As VSSETFRAMEPOS(), _
    <OutAttribute> ByRef pguidRelativeTo As Guid, _
    <OutAttribute> ByRef px As Integer, _
    <OutAttribute> ByRef py As Integer, _
    <OutAttribute> ByRef pcx As Integer, _
    <OutAttribute> ByRef pcy As Integer _
) As Integer

int GetFramePos(
    VSSETFRAMEPOS[] pdwSFP,
    out Guid pguidRelativeTo,
    out int px,
    out int py,
    out int pcx,
    out int pcy
)

int GetFramePos(
    [OutAttribute] array<VSSETFRAMEPOS>^ pdwSFP, 
    [OutAttribute] Guid% pguidRelativeTo, 
    [OutAttribute] int% px, 
    [OutAttribute] int% py, 
    [OutAttribute] int% pcx, 
    [OutAttribute] int% pcy
)

abstract GetFramePos : 
        pdwSFP:VSSETFRAMEPOS[] byref * 
        pguidRelativeTo:Guid byref * 
        px:int byref * 
        py:int byref * 
        pcx:int byref * 
        pcy:int byref -> int

function GetFramePos(
    pdwSFP : VSSETFRAMEPOS[], 
    pguidRelativeTo : Guid, 
    px : int, 
    py : int, 
    pcx : int, 
    pcy : int
) : int

Parameters

pdwSFP
Type: array<Microsoft.VisualStudio.Shell.Interop.VSSETFRAMEPOS[]
[out] Pointer to the frame position to set. Values are taken from the VSSETFRAMEPOS enumeration.

pguidRelativeTo
Type: System.Guid%
[out] Not used (set to nulla null reference (Nothing in Visual Basic)).

px
Type: System.Int32%
[out] Pointer to the absolute x ordinate.

py
Type: System.Int32%
[out] Pointer to the absolute y ordinate.

pcx
Type: System.Int32%
[out] Pointer to the x ordinate relative to px.

pcy
Type: System.Int32%
[out] Pointer to the y ordinate relative to py.

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 vsshell.idl:

HRESULT IVsWindowFrame::GetFramePos(
   [out] VSSETFRAMEPOS *pdwSFP,
   [out] GUID *pguidRelativeTo,
   [out] int *px,
   [out] int *py,
   [out] int *pcx,
   [out] int *pcy
);

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

Share via