IRDPSRAPIFrameBuffer::GetFrameBufferBits method

Gets the bits in a specified area of the frame.

Syntax


HRESULT GetFrameBufferBits(
  [in]          long            x,
  [in]          long            y,
  [in]          long            Width,
  [in]          long            Heigth,
  [out, retval] SAFEARRAY(BYTE) *pbBits
);

Parameters

x [in]

The x coordinate of the requested area of the frame.

y [in]

The y coordinate of the requested area of the frame.

Width [in]

The width of the requested area of the frame.

Heigth [in]

The height of the requested area of the frame.

pbBits [out, retval]

The contents of the frame buffer in the specified area.

Return value

If the method succeeds, the return value is S_OK. Otherwise, the return value is an error code.

Requirements

Minimum supported client

Windows 10 [desktop apps only]

Minimum supported server

Windows Server 2016

Header

RdpEncomAPI.h

IDL

RdpEncomAPI.idl

Type library

RdpEncomAPI.tlb

DLL

RdpEncom.dll

CLSID

CLSID_RDPSRAPIFrameBuffer is defined as a4f66bcc-538e-4101-951d-30847adb5101

IID

IID_IRDPSRAPIFrameBuffer is defined as 3d67e7d2-b27b-448e-81b3-c6110ed8b4be

See also

IRDPSRAPIFrameBuffer

 

 

Show: